difftreelog
Doc style fix
in: master
1 file changed
pallets/scheduler/src/lib.rsdiffbeforeafterboth32// See the License for the specific language governing permissions and32// See the License for the specific language governing permissions and33// limitations under the License.33// limitations under the License.343435//! # Schedulerdo_reschedule35//! # Unique scheduler36//! A Pallet for scheduling dispatches.37//!38//! - [`Config`]39//! - [`Call`]40//! - [`Pallet`]41//!42//! ## Overview36//!43//!37//! This Pallet exposes capabilities for scheduling dispatches to occur at a44//! This Pallet exposes capabilities for scheduling dispatches to occur at a38//! specified block number or at a specified period. These scheduled dispatches45//! specified block number or at a specified period. These scheduled dispatches46//! If a call is scheduled using proxy or whatever mecanism which adds filter,53//! If a call is scheduled using proxy or whatever mecanism which adds filter,47//! then those filter will not be used when dispatching the schedule call.54//! then those filter will not be used when dispatching the schedule call.48//!55//!49//! The scheduler is designed for deferred transaction calls by block number.56//! **NOTE:** The unique scheduler is designed for deferred transaction calls by block number.50//! Any user can book a call of a certain transaction to a specific block number.57//! Any user can book a call of a certain transaction to a specific block number.51//! Also possible to book a call with a certain frequency.58//! Also possible to book a call with a certain frequency.52//! Key differences from original pallet:59//! Key differences from original pallet:53//! Id restricted by 16 bytes60//! Id restricted by 16 bytes54//! Priority limited by HARD DEADLINE (<= 63). Calls over maximum weight don't include to block61//! Priority limited by HARD DEADLINE (<= 63). Calls over maximum weight don't include to block55//! Maybe_periodic limit is 100 calls62//! Maybe_periodic limit is 100 calls56//! Any account allowed to schedule any calls. Account withdraw implemented through default transaction logic.63//! Any account allowed to schedule any calls. Account withdraw implemented through default transaction logic.64//!65//! ## Interface66//!67//! ### Dispatchable Functions68//!69//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a specified block and70//! with a specified priority.71//! * `cancel` - cancel a scheduled dispatch, specified by block number and index.72//! * `schedule_named` - augments the `schedule` interface with an additional `Vec<u8>` parameter73//! that can be used for identification.74//! * `cancel_named` - the named complement to the cancel function.57//!75//!58//! ## Interface76//! ## Interface59//!77//!