doc standardization for networking spec #1338
Merged
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
|
Caught some "behavioUrs" remaining (--> behavior) after the first commit, so I did a second/third look for anything missed the first time. Should be good for squashing into one commit now 👍 |
hwwhww
approved these changes
Aug 7, 2019
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
|
Added @hwwhww's catches (thank you!) |
djrtwo
pushed a commit
that referenced
this pull request
Aug 22, 2019
* Update p2p-interface.md * Update p2p-interface.md * Update p2p-interface.md * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
protolambda
pushed a commit
that referenced
this pull request
Aug 23, 2019
* Update p2p-interface.md * Update p2p-interface.md * Update p2p-interface.md * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com> * Update specs/networking/p2p-interface.md Co-Authored-By: Hsiao-Wei Wang <hwwang156@gmail.com>
CarlBeek
added a commit
that referenced
this pull request
Sep 16, 2019
* dev: (25 commits) Update README.md Update README.md Update sync_protocol.md Update sync_protocol.md Update sync_protocol.md Deposit contract fixes (#1362) fix minor testing bug Update specs/networking/p2p-interface.md add note on local aggregation for interop Fix ssz-generic bitvector tests: those invalid cases of higher length than type describes, but same byte size, should have at least 1 bit set in the overflow to be invalid minor formatting Minor corrections and clarifications to the network specification doc standardization for networking spec (#1338) discuss length-prefixing pro/con, consider for removal, add link cleanups Updates apply more editorial suggestions. apply editorial suggestions. fmt. document doctoc command for posterity. ...
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.
Following up on #1039 and #1212 for the new networking spec doc, given many different writers involved!
Summary:
Added a title to it (just used the title of the doc's original PR #1328), stay-on-the-same-spec links, some British spelling instances converted to American (mostly -ised & -isation turned to -ized & -ization), grammatical commas, abbreviations Eth 2.0/Eth2.0/eth2.0/ETH 2.0/ETH2 standardized to “Eth 2.0” (except for in code snippets, which are left untouched), em dashes put in where they were intended to be used but an en dash was there (they look similar when editing, but not on the published doc), standardization when a recurring phrase is used (example: upon seeing "and then compressed with snappy" and "and subsequently compressed with Snappy" --> capitalizing Snappy and using the lighter "then" for both), other misc. edits