code documentation cleaning

anoma · Nov 11, 2022 · 7a47773 · 7a47773
1 parent bad8063
commit 7a47773
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/shared/src/ledger/inflation.rs b/shared/src/ledger/inflation.rs
@@ -1,5 +1,3 @@
-//! General inflation system that will be used to process rewards for proof-of-stake, providing liquity to shielded asset pools, and public goods funding.
-//! 
 //! General inflation system that will be used to process rewards for
 //! proof-of-stake, providing liquity to shielded asset pools, and public goods
 //! funding.
@@ -14,8 +12,11 @@ use crate::types::token;
 
 /// The domains of inflation
 pub enum RewardsType {
+    /// Proof-of-stake rewards
     Staking,
+    /// Rewards for locking tokens in the multi-asset shielded pool
     Masp,
+    /// Rewards for public goods funding (PGF)
     PubGoodsFunding,
 }
 

diff --git a/shared/src/ledger/parameters/mod.rs b/shared/src/ledger/parameters/mod.rs
@@ -433,6 +433,7 @@ where
         decode(value.ok_or(ReadError::ParametersMissing)?)
             .map_err(ReadError::StorageTypeError)?;
 
+    // read max expected block time
     let max_expected_time_per_block_key =
         storage::get_max_expected_time_per_block_key();
     let (value, gas_time) = storage