chore: clarify docs further

Co-authored-by: Rootul P <rootulp@gmail.com>
celestiaorg · Feb 22, 2023 · 84a492c · 84a492c
1 parent 68a1ea6
commit 84a492c
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/pkg/wrapper/nmt_wrapper.go b/pkg/wrapper/nmt_wrapper.go
@@ -28,8 +28,10 @@ type ErasuredNamespacedMerkleTree struct {
 	// axisIndex is the index of the axis that this tree is on. This is passed
 	// by rsmt2d and used to help determine which quadrant each leaf belongs to.
 	axisIndex uint64
-	// shareIndex is the index of the share that is being pushed to the tree. It
-	// is used to help determine which quadrant each leaf belongs to.
+	// shareIndex is the index of the share in a row or column that is being
+	// pushed to the tree. It is expected to be in the range: 0 <= shareIndex <
+	// 2*squareSize. shareIndex is used to help determine which quadrant each
+	// leaf belongs to.
 	shareIndex uint64
 }