From c6515e6c8b2b9f1c008f7e298012f87d8ae8ad8a Mon Sep 17 00:00:00 2001 From: thiolliere Date: Thu, 31 Oct 2019 16:28:10 +0100 Subject: [PATCH 1/2] improve doc --- srml/support/src/storage/mod.rs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/srml/support/src/storage/mod.rs b/srml/support/src/storage/mod.rs index 5636d211990b9..01b58833b3955 100644 --- a/srml/support/src/storage/mod.rs +++ b/srml/support/src/storage/mod.rs @@ -28,6 +28,9 @@ pub mod child; pub mod generator; /// A trait for working with macro-generated storage values under the substrate storage API. +/// +/// Details on implementation can be found at +/// [generator::StorageValue](./generator/trait.StorageValue.html) pub trait StorageValue { /// The type that get/take return. type Query; @@ -113,6 +116,9 @@ pub trait StorageValue { } /// A strongly-typed map in storage. +/// +/// Details on implementation can be found at +/// [generator::StorageMap](./generator/trait.StorageMap.html) pub trait StorageMap { /// The type that get/take return. type Query; @@ -180,6 +186,9 @@ pub trait StorageMap { /// A strongly-typed linked map in storage. /// /// Similar to `StorageMap` but allows to enumerate other elements and doesn't implement append. +/// +/// Details on implementation can be found at +/// [generator::StorageLinkedMap](./generator/trait.StorageLinkedMap.html) pub trait StorageLinkedMap { /// The type that get/take return. type Query; @@ -229,6 +238,9 @@ pub trait StorageLinkedMap { /// /// It provides an important ability to efficiently remove all entries /// that have a common first key. +/// +/// Details on implementation can be found at +/// [generator::StorageDoubleMap](./generator/trait.StorageDoubleMap.html) pub trait StorageDoubleMap { /// The type that get/take returns. type Query; From f27889ddea3fa0eb13e7093fd1ee56d7f04b8bc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastian=20K=C3=B6cher?= Date: Thu, 31 Oct 2019 17:03:33 +0100 Subject: [PATCH 2/2] Apply suggestions from code review --- srml/support/src/storage/mod.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/srml/support/src/storage/mod.rs b/srml/support/src/storage/mod.rs index 01b58833b3955..d54ae161eed3a 100644 --- a/srml/support/src/storage/mod.rs +++ b/srml/support/src/storage/mod.rs @@ -30,7 +30,7 @@ pub mod generator; /// A trait for working with macro-generated storage values under the substrate storage API. /// /// Details on implementation can be found at -/// [generator::StorageValue](./generator/trait.StorageValue.html) +/// [`generator::StorageValue`] pub trait StorageValue { /// The type that get/take return. type Query; @@ -118,7 +118,7 @@ pub trait StorageValue { /// A strongly-typed map in storage. /// /// Details on implementation can be found at -/// [generator::StorageMap](./generator/trait.StorageMap.html) +/// [`generator::StorageMap`] pub trait StorageMap { /// The type that get/take return. type Query; @@ -188,7 +188,7 @@ pub trait StorageMap { /// Similar to `StorageMap` but allows to enumerate other elements and doesn't implement append. /// /// Details on implementation can be found at -/// [generator::StorageLinkedMap](./generator/trait.StorageLinkedMap.html) +/// [`generator::StorageLinkedMap`] pub trait StorageLinkedMap { /// The type that get/take return. type Query; @@ -240,7 +240,7 @@ pub trait StorageLinkedMap { /// that have a common first key. /// /// Details on implementation can be found at -/// [generator::StorageDoubleMap](./generator/trait.StorageDoubleMap.html) +/// [`generator::StorageDoubleMap`] pub trait StorageDoubleMap { /// The type that get/take returns. type Query;