export ProofLeafNode and ProofInnerNode #205
Merged
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
| @@ -92,18 +92,18 @@ func (pin proofInnerNode) Hash(childHash []byte) []byte { | |||
|
|
|||
| //---------------------------------------- | |||
|
|
|||
| type proofLeafNode struct { | |||
| type ProofLeafNode struct { | |||
There was a problem hiding this comment.
Now that we're exporting this, it should be documented as well.
There was a problem hiding this comment.
I agree, and I started writing godoc for it, before I realized I didn't know enough about how these proofs work to write more than a cursory godoc. ("ProofLeafNode provides a merkle proof for a leaf node" is not terribly helpful.)
None of our proof types are documented anywhere at the moment, and this lack of clarity on my part was the motivation for opening #204. Godoc for proofs can either happen along with that issue or right after it.
There was a problem hiding this comment.
Ah, right. Sure, let's document it then.
erikgrinaker
approved these changes
Jan 31, 2020
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 #73.