diff --git a/substrate/srml/example/src/lib.rs b/substrate/srml/example/src/lib.rs index d1ff7cc634..6960d635ed 100644 --- a/substrate/srml/example/src/lib.rs +++ b/substrate/srml/example/src/lib.rs @@ -24,12 +24,19 @@ //! //! ### Documentation Guidelines: //! -//! +//! +//! //!
/// comment) - should accompany module functions and be restricted to the module interface, not the internals of the module implementation. Only state inputs, outputs, and a brief description that mentions whether calling it requires root, but without repeating the source code details. Capitalise the first word of each documentation comment and end it with a full stop. See Generic example of annotating source code with documentation comments/// comment) - should accompany module functions and be
+//! restricted to the module interface, not the internals of the module implementation. Only state inputs,
+//! outputs, and a brief description that mentions whether calling it requires root, but without repeating
+//! the source code details. Capitalise the first word of each documentation comment and end it with a full
+//! stop. See Generic example of annotating source code with documentation commentsINHERENT_IDENTIFIER, InherentType, u64)INHERENT_IDENTIFIER, InherentType,
+//! u64)//! // Add heading with custom module name //! @@ -47,6 +55,13 @@ //! //! // Add simple description //! +//! // Include the following links that shows what trait needs to be implemented to use the module +//! // and the supported dispatchables that are documented in the Call enum. +//! +//! - \[`::Trait`](./trait.Trait.html) +//! - \[`Call`](./enum.Call.html) +//! - \[`Module`](./struct.Module.html) +//! //! \## Overview //! //! @@ -59,12 +74,6 @@ //! // Inputs it uses and the source of each input. //! // Outputs it produces. //! -//!
-//! -//! Standard format (example): "The timestamp module provides functionality to get and set the on-chain time. -//! To use the timestamp module you need to implement the following [Trait] (). -//! Supported dispatchables are documented in the [Call] enum." -//! //! //! //! @@ -75,8 +84,7 @@ //! // use some judgment about what is included. We don't want a list of every storage item nor types - the user //! // can go to the code for that. For example, "transfer fee" is obvious and should not be included, but //! // "free balance" and "reserved balance" should be noted to give context to the module. -//! -//!
+//! // Please do not link to outside resources. The reference docs should be the ultimate source of truth. //! //! //! @@ -106,7 +114,8 @@ //! //!\`inherent\`//! -//! +//! +//! //! //! \### Types //! @@ -212,8 +221,6 @@ //! // - Substrate TCR https://github.com/parity-samples/substrate-tcr //! // - Substrate Kitties https://shawntabrizi.github.io/substrate-collectables-workshop/#/ //! -//! // Show a usage example in an actual runtime -//! //! \## Genesis Config //! //!