Improve docs / comments

CosmWasm · Dec 6, 2021 · 11c3e6f · 11c3e6f
1 parent cd4db6b
commit 11c3e6f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/packages/storage-plus/src/indexed_map.rs b/packages/storage-plus/src/indexed_map.rs
@@ -18,7 +18,7 @@ pub trait IndexList<T> {
 }
 
 // TODO: remove traits here and make this const fn new
-/// IndexedBucket works like a bucket but has a secondary index
+/// `IndexedMap` works like a `Map` but has a secondary index
 pub struct IndexedMap<'a, K, T, I>
 where
     K: PrimaryKey<'a>,
@@ -574,7 +574,7 @@ mod test {
         let count = marias.len();
         assert_eq!(2, count);
 
-        // Sorted by (descending) pk
+        // Pks, sorted by (descending) pk
         assert_eq!(marias[0].0, b"5629");
         assert_eq!(marias[1].0, b"5627");
         // Data is correct
@@ -630,7 +630,7 @@ mod test {
         let count = marias.len();
         assert_eq!(2, count);
 
-        // Sorted by (descending) pk
+        // Pks, sorted by (descending) pk
         assert_eq!(marias[0].0, "5629");
         assert_eq!(marias[1].0, "5627");
         // Data is correct
@@ -694,7 +694,7 @@ mod test {
         let count = marias.len();
         assert_eq!(2, count);
 
-        // Pks (sorted by age descending)
+        // Pks, sorted by (descending) age
         assert_eq!(pk1, marias[0].0);
         assert_eq!(pk3, marias[1].0);
 
@@ -759,7 +759,7 @@ mod test {
         let count = marias.len();
         assert_eq!(2, count);
 
-        // Remaining part (age) of the index keys, plus pks (bytes) (sorted by age descending)
+        // Pks, sorted by (descending) age
         assert_eq!(pk1, marias[0].0);
         assert_eq!(pk3, marias[1].0);
 

diff --git a/packages/storage-plus/src/indexed_snapshot.rs b/packages/storage-plus/src/indexed_snapshot.rs
@@ -12,7 +12,7 @@ use crate::prefix::{namespaced_prefix_range, Bound, Prefix, PrefixBound};
 use crate::snapshot::SnapshotMap;
 use crate::{IndexList, Path, Strategy};
 
-/// IndexedSnapshotMap works like a SnapshotMap but has a secondary index
+/// `IndexedSnapshotMap` works like a `SnapshotMap` but has a secondary index
 pub struct IndexedSnapshotMap<'a, K, T, I> {
     pk_namespace: &'a [u8],
     primary: SnapshotMap<'a, K, T>,