Basic documentation for Scheduler pallet

frame/scheduler/src/lib.rs

@@ -16,31 +16,29 @@
 // limitations under the License.
 
 //! # Scheduler
+//! A module for scheduling dispatches.
 //!
-//! \# Scheduler
+//! - [`scheduler::Trait`](./trait.Trait.html)
+//! - [`Call`](./enum.Call.html)
+//! - [`Module`](./struct.Module.html)
 //!
-//! - \[`scheduler::Trait`](./trait.Trait.html)
-//! - \[`Call`](./enum.Call.html)
-//! - \[`Module`](./struct.Module.html)
+//! ## Overview
 //!
-//! \## Overview
+//! This module 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.
 //!
-//! // Short description of pallet's purpose.
-//! // Links to Traits that should be implemented.
-//! // What this pallet is for.
-//! // What functionality the pallet provides.
-//! // When to use the pallet (use case examples).
-//! // How it is used.
-//! // Inputs it uses and the source of each input.
-//! // Outputs it produces.
+//! ## Interface
 //!
-//! \## Terminology
+//! ### Dispatchable Functions
 //!
-//! \## Goals
-//!
-//! \## 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<u8>` 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)]