pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-07-24 12:25:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve doc of pallet macro (#9625)

Browse Source 
* improve doc

* fmt
This commit is contained in:
Guillaume Thiolliere
2021-08-26 03:14:09 +02:00
committed by GitHub
parent 7c3890c652
commit 0f1896e7a2
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/frame/support/src/lib.rs
+15 -1
View File
@@ -1693,7 +1693,19 @@ pub mod pallet_prelude {
/// E.g. if runtime names the pallet "MyExample" then the storage `type Foo<T> = ...` use the /// E.g. if runtime names the pallet "MyExample" then the storage `type Foo<T> = ...` use the
/// prefix: `Twox128(b"MyExample") ++ Twox128(b"Foo")`. /// prefix: `Twox128(b"MyExample") ++ Twox128(b"Foo")`.
/// ///
/// The optional attribute `#[pallet::getter(fn $my_getter_fn_name)]` allow to define a /// The optional attribute `#[pallet::storage_prefix = "$custom_name"]` allows to define a
/// specific name to use for the prefix.
///
/// E.g:
/// ```ignore
/// #[pallet::storage]
/// #[pallet::storage_prefix = "OtherName"]
/// pub(super) type MyStorage<T> = StorageMap<Hasher = Blake2_128Concat, Key = u32, Value = u32>;
/// ```
/// In this case the final prefix used by the map is
/// `Twox128(b"MyExample") ++ Twox128(b"OtherName")`.
///
/// The optional attribute `#[pallet::getter(fn $my_getter_fn_name)]` allows to define a
/// getter function on `Pallet`. /// getter function on `Pallet`.
/// ///
/// E.g: /// E.g:
@@ -2023,6 +2035,7 @@ pub mod pallet_prelude {
/// // Another storage declaration /// // Another storage declaration
/// #[pallet::storage] /// #[pallet::storage]
/// #[pallet::getter(fn my_storage)] /// #[pallet::getter(fn my_storage)]
/// #[pallet::storage_prefix = "SomeOtherName"]
/// pub(super) type MyStorage<T> = /// pub(super) type MyStorage<T> =
/// StorageMap<Hasher = Blake2_128Concat, Key = u32, Value = u32>; /// StorageMap<Hasher = Blake2_128Concat, Key = u32, Value = u32>;
/// ///
@@ -2165,6 +2178,7 @@ pub mod pallet_prelude {
/// ///
/// #[pallet::storage] /// #[pallet::storage]
/// #[pallet::getter(fn my_storage)] /// #[pallet::getter(fn my_storage)]
/// #[pallet::storage_prefix = "SomeOtherName"]
/// pub(super) type MyStorage<T, I = ()> = /// pub(super) type MyStorage<T, I = ()> =
/// StorageMap<Hasher = Blake2_128Concat, Key = u32, Value = u32>; /// StorageMap<Hasher = Blake2_128Concat, Key = u32, Value = u32>;
/// ///