Chapter 3 - Add link to PR that renames CChainState#45
Merged
Conversation
Collaborator
|
Also happy to add this, although it is alluded to in the General Design Principles tip box ;) |
Contributor
Author
|
Omg I totally forgot about this! Good point 👍 |
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.
Chapter 3: The Multiple Chains section talks about the
CChainStatedata structure, however it will be renamed toChainstatein v24.0 per PR #24513.I know this book explicitly states that it's written with v23.0 as a reference, but readers may be pointing to a more recent copy of the code, especially if they are periodically revisiting this book in between other activities like PR review. If they try to grep the code base for 'CChainState', they probably won't find anything. Maybe release notes if they are lucky?
The PR also has a delightful description and reviewing it is probably a good exercise for beginners in understanding the implications of a large renaming PR like this.
I understand it is simpler to leave this out, but I think there is a case to be made for mentioning the rename!