From 256a0bbe77d908e702ec0b8a3dc0a50357f03c00 Mon Sep 17 00:00:00 2001
From: brentstone <brent@heliax.dev>
Date: Wed, 27 Sep 2023 18:21:59 -0600
Subject: [PATCH] docstring cleanup

---
 proof_of_stake/src/epoched.rs | 2 +-
 proof_of_stake/src/types.rs   | 9 ++++-----
 2 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/proof_of_stake/src/epoched.rs b/proof_of_stake/src/epoched.rs
index 801fd0dcb1..8f32138f22 100644
--- 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
index 88881aae84..8807b8072e 100644
--- a/proof_of_stake/src/types.rs
+++ b/proof_of_stake/src/types.rs
@@ -24,7 +24,8 @@ 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>,
@@ -32,8 +33,6 @@ pub type ValidatorSetPositions = crate::epoched::NestedEpoched<
     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,