docs: Fix grammatical errors and improve clarity in documentation and comments#3716
Merged
StephenButtolph merged 11 commits intoava-labs:masterfrom Feb 16, 2025
Merged
docs: Fix grammatical errors and improve clarity in documentation and comments#3716StephenButtolph merged 11 commits intoava-labs:masterfrom
StephenButtolph merged 11 commits intoava-labs:masterfrom
Conversation
Signed-off-by: VolodymyrBg <[email protected]>
Signed-off-by: VolodymyrBg <[email protected]>
Signed-off-by: VolodymyrBg <[email protected]>
Signed-off-by: VolodymyrBg <[email protected]>
Signed-off-by: VolodymyrBg <[email protected]>
VolodymyrBg
requested review from
StephenButtolph and
meaghanfitzgerald
as code owners
StephenButtolph
requested changes
Feb 12, 2025
Contributor
StephenButtolph
left a comment
StephenButtolph
left a comment
There was a problem hiding this comment.
iff is common mathematical shorthand for if and only if.
I think the fixes other than the x/merkledb/README.md should be reverted.
Contributor
Author
Sorry I didn't know about iff, I'm gonna correct it right now |
Signed-off-by: VolodymyrBg <[email protected]>
Signed-off-by: VolodymyrBg <[email protected]>
Signed-off-by: VolodymyrBg <[email protected]>
Signed-off-by: VolodymyrBg <[email protected]>
Signed-off-by: VolodymyrBg <[email protected]>
Signed-off-by: VolodymyrBg <[email protected]>
Contributor
Author
|
@StephenButtolph Corrected |
meaghanfitzgerald
approved these changes
Feb 12, 2025
StephenButtolph
approved these changes
Feb 13, 2025
Contributor
Author
|
@StephenButtolph Im glad that i was useful, could you merge it, please? |
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.
Why this should be merged
This PR fixes grammatical errors in comments and documentation, improving clarity and readability. It replaces instances of "iff" with "if" and refines several explanations to be more precise.
How this works
The changes update inline comments and documentation across multiple files (db.go, key.go, node.go, and proof.go). These modifications ensure that the text is grammatically correct without altering functionality.
How this was tested
Since this PR only modifies comments and documentation, no functional testing is required. However, a thorough review was performed to ensure correctness and consistency in the wording.
Need to be documented in RELEASES.md?
No, as this PR does not introduce any functional changes.