Fix Terminology in Block Locators for Consistency with NUM_RECENT_BLO… #3428
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
…CKS Constant This PR updates several instances of the term NUM_RECENTS to NUM_RECENT_BLOCKS across block_locators.rs to ensure terminology consistency with the constant NUM_RECENT_BLOCKS. The changes affect both function documentation comments and error messages for clearer understanding and maintenance. Signed-off-by: Hwangjae Lee <[email protected]>
vicsn
approved these changes
Nov 4, 2024
ljedrz
approved these changes
Nov 5, 2024
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.
…CKS Constant
This PR updates several instances of the term NUM_RECENTS to NUM_RECENT_BLOCKS across block_locators.rs to ensure terminology consistency with the constant NUM_RECENT_BLOCKS. The changes affect both function documentation comments and error messages for clearer understanding and maintenance.
Motivation
The primary motivation behind this PR is to improve code readability and consistency in block_locators.rs by aligning terminology with the defined constant, NUM_RECENT_BLOCKS. Previously, the code used both NUM_RECENTS and NUM_RECENT_BLOCKS, which could lead to confusion among developers. By standardizing on NUM_RECENT_BLOCKS across all function documentation comments and error messages, this PR ensures clearer communication of the code’s intent, reducing the potential for misunderstandings and making maintenance more straightforward. Consistent terminology is especially valuable in collaborative environments, helping developers work more effectively with shared code.
Test Plan
(If you changed any code, please provide clear instructions on how you verified your changes work.)
Related PRs
(Link any related PRs here)