fix doc

Author: open-junius

pallets/subtensor/src/lib.rs

@@ -976,15 +976,15 @@ pub mod pallet {
     /// --- ITEM ( min_childkey_take )
     pub type MinChildkeyTake<T> = StorageValue<_, u16, ValueQuery, DefaultMinChildKeyTake<T>>;
     #[pallet::storage]
-    /// MAP ( hot ) --> cold, Returns the controlling coldkey for a hotkey
+    /// MAP ( hot ) --> cold | Returns the controlling coldkey for a hotkey
     pub type Owner<T: Config> =
         StorageMap<_, Blake2_128Concat, T::AccountId, T::AccountId, ValueQuery, DefaultAccount<T>>;
     #[pallet::storage]
-    /// MAP ( hot ) --> take, Returns the hotkey delegation take. And signals that this key is open for delegation
+    /// MAP ( hot ) --> take | Returns the hotkey delegation take. And signals that this key is open for delegation
     pub type Delegates<T: Config> =
         StorageMap<_, Blake2_128Concat, T::AccountId, u16, ValueQuery, DefaultDelegateTake<T>>;
     #[pallet::storage]
-    /// DMAP ( hot, netuid ) --> take, Returns the hotkey childkey take for a specific subnet
+    /// DMAP ( hot, netuid ) --> take | Returns the hotkey childkey take for a specific subnet
     pub type ChildkeyTake<T: Config> = StorageDoubleMap<
         _,
         Blake2_128Concat,
@@ -1112,42 +1112,42 @@ pub mod pallet {
         StorageMap<_, Identity, NetUid, u128, ValueQuery, DefaultZeroU128<T>>;
 
     #[pallet::storage]
-    /// --- MAP ( netuid ) --> tao_in_subnet, Returns the amount of TAO in the subnet.
+    /// --- MAP ( netuid ) --> tao_in_subnet | Returns the amount of TAO in the subnet.
     pub type SubnetTAO<T: Config> =
         StorageMap<_, Identity, NetUid, TaoCurrency, ValueQuery, DefaultZeroTao<T>>;
 
     #[pallet::storage]
-    /// --- MAP ( netuid ) --> tao_in_user_subnet, Returns the amount of TAO in the subnet reserve provided by users as liquidity.
+    /// --- MAP ( netuid ) --> tao_in_user_subnet | Returns the amount of TAO in the subnet reserve provided by users as liquidity.
     pub type SubnetTaoProvided<T: Config> =
         StorageMap<_, Identity, NetUid, TaoCurrency, ValueQuery, DefaultZeroTao<T>>;
 
     #[pallet::storage]
-    /// --- MAP ( netuid ) --> alpha_in_emission, Returns the amount of alph in  emission into the pool per block.
+    /// --- MAP ( netuid ) --> alpha_in_emission | Returns the amount of alph in  emission into the pool per block.
     pub type SubnetAlphaInEmission<T: Config> =
         StorageMap<_, Identity, NetUid, AlphaCurrency, ValueQuery, DefaultZeroAlpha<T>>;
 
     #[pallet::storage]
-    /// --- MAP ( netuid ) --> alpha_out_emission, Returns the amount of alpha out emission into the network per block.
+    /// --- MAP ( netuid ) --> alpha_out_emission | Returns the amount of alpha out emission into the network per block.
     pub type SubnetAlphaOutEmission<T: Config> =
         StorageMap<_, Identity, NetUid, AlphaCurrency, ValueQuery, DefaultZeroAlpha<T>>;
 
     #[pallet::storage]
-    /// --- MAP ( netuid ) --> tao_in_emission, Returns the amount of tao emitted into this subent on the last block.
+    /// --- MAP ( netuid ) --> tao_in_emission | Returns the amount of tao emitted into this subent on the last block.
     pub type SubnetTaoInEmission<T: Config> =
         StorageMap<_, Identity, NetUid, TaoCurrency, ValueQuery, DefaultZeroTao<T>>;
 
     #[pallet::storage]
-    /// --- MAP ( netuid ) --> alpha_supply_in_pool, Returns the amount of alpha in the pool.
+    /// --- MAP ( netuid ) --> alpha_supply_in_pool | Returns the amount of alpha in the pool.
     pub type SubnetAlphaIn<T: Config> =
         StorageMap<_, Identity, NetUid, AlphaCurrency, ValueQuery, DefaultZeroAlpha<T>>;
 
     #[pallet::storage]
-    /// --- MAP ( netuid ) --> alpha_supply_user_in_pool, Returns the amount of alpha in the pool provided by users as liquidity.
+    /// --- MAP ( netuid ) --> alpha_supply_user_in_pool | Returns the amount of alpha in the pool provided by users as liquidity.
     pub type SubnetAlphaInProvided<T: Config> =
         StorageMap<_, Identity, NetUid, AlphaCurrency, ValueQuery, DefaultZeroAlpha<T>>;
 
     #[pallet::storage]
-    /// --- MAP ( netuid ) --> alpha_supply_in_subnet, Returns the amount of alpha in the subnet.
+    /// --- MAP ( netuid ) --> alpha_supply_in_subnet | Returns the amount of alpha in the subnet.
     pub type SubnetAlphaOut<T: Config> =
         StorageMap<_, Identity, NetUid, AlphaCurrency, ValueQuery, DefaultZeroAlpha<T>>;
 
@@ -1157,12 +1157,12 @@ pub mod pallet {
         StorageMap<_, Blake2_128Concat, T::AccountId, Vec<T::AccountId>, ValueQuery>;
 
     #[pallet::storage]
-    /// --- MAP ( cold ) --> Vec<hot>, Returns the vector of hotkeys controlled by this coldkey.
+    /// --- MAP ( cold ) --> Vec<hot> | Returns the vector of hotkeys controlled by this coldkey.
     pub type OwnedHotkeys<T: Config> =
         StorageMap<_, Blake2_128Concat, T::AccountId, Vec<T::AccountId>, ValueQuery>;
 
     #[pallet::storage]
-    /// --- DMAP ( cold, netuid )--> hot, Returns the hotkey a coldkey will autostake to with mining rewards.
+    /// --- DMAP ( cold, netuid )--> hot | Returns the hotkey a coldkey will autostake to with mining rewards.
     pub type AutoStakeDestination<T: Config> = StorageDoubleMap<
         _,
         Blake2_128Concat,
@@ -1174,7 +1174,7 @@ pub mod pallet {
     >;
 
     #[pallet::storage]
-    /// --- DMAP ( hot, netuid )--> Vec<cold>, Returns a list of coldkeys that are autostaking to a hotkey
+    /// --- DMAP ( hot, netuid )--> Vec<cold> | Returns a list of coldkeys that are autostaking to a hotkey
     pub type AutoStakeDestinationColdkeys<T: Config> = StorageDoubleMap<
         _,
         Blake2_128Concat,
@@ -1197,7 +1197,7 @@ pub mod pallet {
     >;
 
     #[pallet::storage]
-    /// --- DMAP ( hot, netuid ) --> alpha, Returns the total amount of alpha a hotkey owns.
+    /// --- DMAP ( hot, netuid ) --> alpha | Returns the total amount of alpha a hotkey owns.
     pub type TotalHotkeyAlpha<T: Config> = StorageDoubleMap<
         _,
         Blake2_128Concat,
@@ -1209,7 +1209,7 @@ pub mod pallet {
         DefaultZeroAlpha<T>,
     >;
     #[pallet::storage]
-    /// --- DMAP ( hot, netuid ) --> alpha, Returns the total amount of alpha a hotkey owned in the last epoch.
+    /// --- DMAP ( hot, netuid ) --> alpha | Returns the total amount of alpha a hotkey owned in the last epoch.
     pub type TotalHotkeyAlphaLastEpoch<T: Config> = StorageDoubleMap<
         _,
         Blake2_128Concat,
@@ -1221,7 +1221,7 @@ pub mod pallet {
         DefaultZeroAlpha<T>,
     >;
     #[pallet::storage]
-    /// DMAP ( hot, netuid ) --> total_alpha_shares, Returns the number of alpha shares for a hotkey on a subnet.
+    /// DMAP ( hot, netuid ) --> total_alpha_shares | Returns the number of alpha shares for a hotkey on a subnet.
     pub type TotalHotkeyShares<T: Config> = StorageDoubleMap<
         _,
         Blake2_128Concat,
@@ -1233,7 +1233,7 @@ pub mod pallet {
         DefaultSharePoolZero<T>,
     >;
     #[pallet::storage]
-    /// --- NMAP ( hot, cold, netuid ) --> alpha, Returns the alpha shares for a hotkey, coldkey, netuid triplet.
+    /// --- NMAP ( hot, cold, netuid ) --> alpha | Returns the alpha shares for a hotkey, coldkey, netuid triplet.
     pub type Alpha<T: Config> = StorageNMap<
         _,
         (
@@ -1245,7 +1245,7 @@ pub mod pallet {
         ValueQuery,
     >;
     #[pallet::storage]
-    /// --- MAP ( netuid ) --> token_symbol, Returns the token symbol for a subnet.
+    /// --- MAP ( netuid ) --> token_symbol | Returns the token symbol for a subnet.
     pub type TokenSymbol<T: Config> =
         StorageMap<_, Identity, NetUid, Vec<u8>, ValueQuery, DefaultUnicodeVecU8<T>>;
 
@@ -1765,7 +1765,7 @@ pub mod pallet {
     /// ==== Axon / Promo Endpoints =====
     /// =================================
     #[pallet::storage]
-    /// --- NMAP ( hot, netuid, name ) --> last_block, Returns the last block of a transaction for a given key, netuid, and name.
+    /// --- NMAP ( hot, netuid, name ) --> last_block | Returns the last block of a transaction for a given key, netuid, and name.
     pub type TransactionKeyLastBlock<T: Config> = StorageNMap<
         _,
         (
@@ -1909,7 +1909,7 @@ pub mod pallet {
         StorageDoubleMap<_, Twox64Concat, LeaseId, Identity, T::AccountId, U64F64, ValueQuery>;
 
     #[pallet::storage]
-    // --- MAP ( netuid ) --> lease_id | The lease id for a given netuid.
+    /// --- MAP ( netuid ) --> lease_id | The lease id for a given netuid.
     pub type SubnetUidToLeaseId<T: Config> =
         StorageMap<_, Twox64Concat, NetUid, LeaseId, OptionQuery>;