fix(docs): align BlockValidationResult doc comments with C API - #184
Merged
Conversation
Several doc comments were inaccurate or vaguer than the upstream definitions. Importantly, Consensus was documented as "Block is valid according to consensus rules" when it actually means the opposite - a consensus rule violation. Align all affected variants with the upstream comments for accuracy.
alexanderwiederin
added
the
no-changelog
Owner
|
LGTM Thanks for patching this, I hope this is the last instance of my old, sloppy docs. |
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
2 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.
Several doc comments were inaccurate or vaguer than the upstream definitions. Importantly,
Consensuswas documented as "Block is valid according to consensus rules" when it actually means the opposite - a consensus rule violation. Align all affected variants with the upstream comments for accuracy.