Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Commit

Permalink
schedule_para_{init,cleanup} docs
Browse files Browse the repository at this point in the history
Now they link to their original declarations in the pallet for more
details.
  • Loading branch information
pepyakin committed Nov 25, 2021
1 parent 65f8ba4 commit f9f45df
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions runtime/parachains/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ pub use paras::ParaLifecycle;
use primitives::v1::Id as ParaId;

/// Schedule a para to be initialized at the start of the next session with the given genesis data.
///
/// See [`paras::Pallet::schedule_para_initialize`] for more details.
pub fn schedule_para_initialize<T: paras::Config>(
id: ParaId,
genesis: paras::ParaGenesisArgs,
Expand All @@ -60,6 +62,8 @@ pub fn schedule_para_initialize<T: paras::Config>(
}

/// Schedule a para to be cleaned up at the start of the next session.
///
/// See [`paras::Pallet::schedule_para_cleanup`] for more details.
pub fn schedule_para_cleanup<T: paras::Config>(id: primitives::v1::Id) -> Result<(), ()> {
<paras::Pallet<T>>::schedule_para_cleanup(id).map_err(|_| ())
}
Expand Down

0 comments on commit f9f45df

Please sign in to comment.