Documentation improvements

ZcashFoundation · Jul 13, 2021 · 3607b27 · 3607b27
1 parent a98979f
commit 3607b27
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/zebra-chain/src/orchard/tree.rs b/zebra-chain/src/orchard/tree.rs
@@ -147,7 +147,7 @@ impl ZcashDeserialize for Root {
     }
 }
 
-// A node of the Orchard Incremental Note Commitment Tree.
+/// A node of the Orchard Incremental Note Commitment Tree.
 #[derive(Clone, Debug)]
 struct Node(pallas::Base);
 

diff --git a/zebra-chain/src/sapling/tree.rs b/zebra-chain/src/sapling/tree.rs
@@ -114,7 +114,10 @@ impl From<&Root> for [u8; 32] {
     }
 }
 
-// A node of the Sapling Incremental Note Commitment Tree.
+/// A node of the Sapling Incremental Note Commitment Tree.
+///
+/// Note that it's handled as a byte buffer and not a point coordinate because
+/// that's how the spec handles the MerkleCRH^Sapling function inputs and outputs.
 #[derive(Clone, Debug)]
 struct Node([u8; 32]);