git.delta.rocks / unique-network / refs/commits / e5ffee63ce65

difftreelog

Doc style fix

Dev2022-07-11parent: #f75f9ea.patch.diff
in: master

1 file changed

modifiedpallets/scheduler/src/lib.rsdiffbeforeafterboth
32// See the License for the specific language governing permissions and32// See the License for the specific language governing permissions and
33// limitations under the License.33// limitations under the License.
3434
35//! # Schedulerdo_reschedule35//! # Unique scheduler
36//! A Pallet for scheduling dispatches.
37//!
38//! - [`Config`]
39//! - [`Call`]
40//! - [`Pallet`]
41//!
42//! ## Overview
36//!43//!
37//! This Pallet exposes capabilities for scheduling dispatches to occur at a44//! This Pallet exposes capabilities for scheduling dispatches to occur at a
38//! specified block number or at a specified period. These scheduled dispatches45//! specified block number or at a specified period. These scheduled dispatches
46//! 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 bytes
54//! 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 block
55//! Maybe_periodic limit is 100 calls62//! Maybe_periodic limit is 100 calls
56//! 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//! ## Interface
66//!
67//! ### Dispatchable Functions
68//!
69//! * `schedule` - schedule a dispatch, which may be periodic, to occur at a specified block and
70//! 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>` parameter
73//! that can be used for identification.
74//! * `cancel_named` - the named complement to the cancel function.
57//!75//!
58//! ## Interface76//! ## Interface
59//!77//!