docs: godoc for computeRowProof #228
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #228 +/- ##
=======================================
Coverage ? 78.26%
=======================================
Files ? 7
Lines ? 529
Branches ? 0
=======================================
Hits ? 414
Misses ? 69
Partials ? 46 |
staheri14
reviewed
Jul 5, 2023
datasquare_test.go
Outdated
| @@ -418,6 +418,9 @@ func BenchmarkEDSRoots(b *testing.B) { | |||
| } | |||
| } | |||
|
|
|||
| // computeRowProof returns the merkle root, proof, proofIndex, and numLeaves for | |||
There was a problem hiding this comment.
It's not immediately clear as what "proof" and "proof index" mean or refer to. It would be great to explain them further.
There was a problem hiding this comment.
I just read the implementation in https://github.com/celestiaorg/merkletree/blob/c33506a7aa26be568fbb9714b3a6f66c1b60d2aa/tree.go#L95-L99 and TBH I don't understand it so closing this PR as unresolved b/c idk how to explain proof or proof index further.
evan-forbes
previously approved these changes
Jul 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #212