From 984163e86e6a0d376faad410d4969f5d7f001d11 Mon Sep 17 00:00:00 2001
From: thiolliere <gui.thiolliere@gmail.com>
Date: Thu, 31 Oct 2019 19:04:53 +0100
Subject: [PATCH] Improve doc for storages in srml-support (#3982)
* improve doc
* Apply suggestions from code review
---
substrate/srml/support/src/storage/mod.rs | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/substrate/srml/support/src/storage/mod.rs b/substrate/srml/support/src/storage/mod.rs
index 5636d211990..d54ae161eed 100644
--- a/substrate/srml/support/src/storage/mod.rs
+++ b/substrate/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`]
pub trait StorageValue<T: FullCodec> {
/// The type that get/take return.
type Query;
@@ -113,6 +116,9 @@ pub trait StorageValue<T: FullCodec> {
}
/// A strongly-typed map in storage.
+///
+/// Details on implementation can be found at
+/// [`generator::StorageMap`]
pub trait StorageMap<K: FullEncode, V: FullCodec> {
/// The type that get/take return.
type Query;
@@ -180,6 +186,9 @@ pub trait StorageMap<K: FullEncode, V: FullCodec> {
/// 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`]
pub trait StorageLinkedMap<K: FullCodec, V: FullCodec> {
/// The type that get/take return.
type Query;
@@ -229,6 +238,9 @@ pub trait StorageLinkedMap<K: FullCodec, V: FullCodec> {
///
/// 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`]
pub trait StorageDoubleMap<K1: FullEncode, K2: FullEncode, V: FullCodec> {
/// The type that get/take returns.
type Query;
--
GitLab