Improve docs on private Witness fields#2930
Merged
apoelstra merged 1 commit intorust-bitcoin:masterfrom Jun 30, 2024
Merged
Conversation
Witness fields
Member
Author
|
Thanks for review, will use |
5d422f3 to
4d97a15
Compare
Member
Author
|
Used your suggestions @Kixunil except I used "Said another way," instead of "IOW" |
Kixunil
reviewed
Jun 29, 2024
The `Witness` type is a reasonable complex data structure, make an effort to clarify its structure in the docs on the private fields. Private docs only.
4d97a15 to
c717f7f
Compare
Member
Author
|
Fixed, thanks. |
Kixunil
approved these changes
Jun 30, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The
Witnesstype is a reasonable complex data structure, make an effort to clarify its structure in the docs on the private fields.Private docs only.
(Original idea pulled out of #2133.)