docstring cleanup

anoma · Sep 28, 2023 · 256a0bb · 256a0bb
1 parent 1ac46a0
commit 256a0bb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/proof_of_stake/src/epoched.rs b/proof_of_stake/src/epoched.rs
@@ -325,7 +325,7 @@ where
         NestedMap::open(key)
     }
 
-    /// Initialize new nested data at the given epoch offset.
+    /// Initialize new nested data at the given epoch.
     pub fn init<S>(
         &self,
         storage: &mut S,

diff --git a/proof_of_stake/src/types.rs b/proof_of_stake/src/types.rs
@@ -24,16 +24,15 @@ pub use rev_order::ReverseOrdTokenAmount;
 
 use crate::parameters::PosParams;
 
-// TODO: add this to the spec
+// TODO: review the offsets for each epoched type!!
+
 /// Stored positions of validators in validator sets
 pub type ValidatorSetPositions = crate::epoched::NestedEpoched<
     LazyMap<Address, Position>,
     crate::epoched::OffsetPipelineLen,
     crate::epoched::OffsetDefaultNumPastEpochs,
 >;
 
-// TODO: check the offsets for each epoched type!!
-
 /// Epoched validator's consensus key.
 pub type ValidatorConsensusKeys = crate::epoched::Epoched<
     common::PublicKey,
@@ -87,7 +86,7 @@ pub type BelowCapacityValidatorSets = crate::epoched::NestedEpoched<
     crate::epoched::OffsetDefaultNumPastEpochs,
 >;
 
-/// Epoched total consensus validator stake
+/// Epoched total consensus validator set stake
 pub type TotalConsensusStakes = crate::epoched::Epoched<
     Amount,
     crate::epoched::OffsetZero,
@@ -123,7 +122,7 @@ pub type Bonds = crate::epoched::EpochedDelta<
 >;
 
 /// An epoched lazy set of all known active validator addresses (consensus,
-/// below-capacity, jailed)
+/// below-capacity, below-threshold, jailed)
 pub type ValidatorAddresses = crate::epoched::NestedEpoched<
     LazySet<Address>,
     crate::epoched::OffsetPipelineLen,