pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-14 08:41:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make existing docs more consistent (#2307)

Browse Source 
* opening and closing links

* sudo example compiles

* add Aura after it was merged to master

* remove extern crate line
This commit is contained in:
joe petrowski
2019-04-17 13:40:13 +02:00
committed by thiolliere
parent 0ae060d4d1
commit 129803efd2
8 changed files with 67 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/srml/aura/src/lib.rs
+7 -4
View File
@@ -16,6 +16,9 @@
//! # Aura Module
//!
//! - [`aura::Trait`](./trait.Trait.html)
//! - [`Module`](./struct.Module.html)
//!
//! ## Overview
//!
//! The Aura module extends Aura consensus by managing offline reporting.
@@ -24,7 +27,7 @@
//!
//! ### Public Functions
//!
//! See the [`Module`](./struct.Module.html) struct for details on publicly available functions.
//! - `slot_duration` - Determine the Aura slot-duration based on the Timestamp module configuration.
//!
//! ## Usage
//!
@@ -48,12 +51,12 @@
//!
//! ## Related Modules
//!
//! - [`staking`](../srml_staking/index.html): The Staking module is called in Aura to enforce slashing
//! - [Staking](../srml_staking/index.html): The Staking module is called in Aura to enforce slashing
//! if validators miss a certain number of slots (see the [`StakingSlasher`](./struct.StakingSlasher.html)
//! struct and associated method).
//! - [`timestamp`](../srml_timestamp/index.html): The Timestamp module is used in Aura to track
//! - [Timestamp](../srml_timestamp/index.html): The Timestamp module is used in Aura to track
//! consensus rounds (via `slots`).
//! - [`consensus`](../srml_consensus/index.html): The Consensus module does not relate directly to Aura,
//! - [Consensus](../srml_consensus/index.html): The Consensus module does not relate directly to Aura,
//! but serves to manage offline reporting by implementing `ProvideInherent` in a similar way.
//!
//! ## References