--- a/pallets/scheduler/src/lib.rs +++ b/pallets/scheduler/src/lib.rs @@ -32,8 +32,15 @@ // See the License for the specific language governing permissions and // limitations under the License. -//! # Schedulerdo_reschedule +//! # Unique scheduler +//! A Pallet for scheduling dispatches. //! +//! - [`Config`] +//! - [`Call`] +//! - [`Pallet`] +//! +//! ## Overview +//! //! This Pallet exposes capabilities for scheduling dispatches to occur at a //! specified block number or at a specified period. These scheduled dispatches //! may be named or anonymous and may be canceled. @@ -46,7 +53,7 @@ //! If a call is scheduled using proxy or whatever mecanism which adds filter, //! then those filter will not be used when dispatching the schedule call. //! -//! The scheduler is designed for deferred transaction calls by block number. +//! **NOTE:** The unique scheduler is designed for deferred transaction calls by block number. //! Any user can book a call of a certain transaction to a specific block number. //! Also possible to book a call with a certain frequency. //! Key differences from original pallet: @@ -65,6 +72,17 @@ //! * `schedule_named` - augments the `schedule` interface with an additional `Vec` parameter //! that can be used for identification. //! * `cancel_named` - the named complement to the cancel function. +//! +//! ## Interface +//! +//! ### Dispatchable Functions +//! +//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a specified block and +//! with a specified priority. +//! * `cancel` - cancel a scheduled dispatch, specified by block number and index. +//! * `schedule_named` - augments the `schedule` interface with an additional `Vec` parameter +//! that can be used for identification. +//! * `cancel_named` - the named complement to the cancel function. // Ensure we're `no_std` when compiling for Wasm. #![cfg_attr(not(feature = "std"), no_std)]