-
Notifications
You must be signed in to change notification settings - Fork 279
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rephrase networks-and-nodes.md documentation #2153
Conversation
✅ Deploy Preview for substrate-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
I would recommend updating the corresponding |
@kianenigma the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than the nits, I think your suggested changes are definitely an improvement.
I would say the original author made the common mistake of confusing "blocks" (a bundle of transactions and a block header) with "state at a block" (the actual state of the chain after having applied all state transitions from all previous blocks), and your words add the correct clarity here.
If anything, a small note on this distinction might be helpful somewhere, but is perhaps beyond the scope of this PR, or what the page should be teaching.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion replace
by spaces
I think the difference between "state transition" and "state" is well explained in the "blockchain basics" page (https://docs.substrate.io/learn/blockchain-basics/). I do not know where the confusion came from, and I feel that emphasizing the difference would induct more confusion. |
no need to save a few characters, it's more clear here Co-authored-by: Shawn Tabrizi <[email protected]>
Co-authored-by: Shawn Tabrizi <[email protected]>
→ space
→ space
apply suggestion Co-authored-by: Shawn Tabrizi <[email protected]>
I found this documentation confusing because it mixed
--state-pruning
and--blocks-pruning
concepts and made think that full nodes discard the blocks when they actually discard the states. I come with this rewrite as a suggestion but it may require proofreading by an expert.As a reminder this is the current node documentation: