This repository was archived by the owner on Jan 9, 2023. It is now read-only.
Docs: Improve protocol description #45
Merged
Conversation
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
stephen-palmer
suggested changes
Jun 6, 2018
Contributor
stephen-palmer
left a comment
stephen-palmer
left a comment
There was a problem hiding this comment.
looks good overall - just a couple of changes needed.
protocol.md
Outdated
| Version and size numbers are sent back end forth in hex-encoding. Eg. the | ||
| version is sent as `000000fe` over the wire (and *not* the binary `000\u00fe`). | ||
|
|
||
| The commentary below is from reading package dumps and some poking at the |
Contributor
There was a problem hiding this comment.
Remove this comment ("The commentary below ...") - doesn't need to be in the doc.
protocol.md
Outdated
|
|
||
| ## Request cached item | ||
| ``` | ||
| # Binary stuff |
Contributor
There was a problem hiding this comment.
Change to "Asset binary"
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Improve protocol description enough that one can follow packet traces etc.