docs: protocol reference - minor line/copyedits, fix broken links, maybe check snake case usage, see comments in code#70
Open
ink7047 wants to merge 1 commit into
Open
Conversation
…ybe check snake case usage, see comments in code -In the test sequence diagrams: Oskar mentioned looking out for snake case usage in his docs, so I thought I would also point it out here. I’m not sure exactly which category the of code the items listed in your test sequence diagrams fall into, and it may be a non-issue. But just in case, here is a reference for any changes that need to be made: https://doc.rust-lang.org/1.0.0/style/style/naming/README.html -In the stream close section: when you use "they" here, are you referring to all the items within the stream? If not I would either pluralize stream (to streams), or use “it” instead of “they” -in the string section (under schemas) where you discuss characters: I rephrased a line for additional clarity here, but if my edit has changed the meaning, please feel free to revise. I considered using “sub-restriction” but that felt a bit too… made-up? Lol. If you know of a word/phrase that gets at that idea, that would be best. -I left comments in the Schema section, specifically for “URL” and “domain”, where a couple of links 404’d and I wasn’t sure where to find the correct link.
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
1 participant
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.
-In the test sequence diagrams: Oskar mentioned looking out for snake case usage in his docs, so I thought I would also point it out here. I’m not sure exactly which category the of code the items listed in your test sequence diagrams fall into, and it may be a non-issue. But just in case, here is a reference for any changes that need to be made: https://doc.rust-lang.org/1.0.0/style/style/naming/README.html
-In the stream close section: when you use "they" here, are you referring to all the items within the stream? If not I would either pluralize stream (to streams), or use “it” instead of “they”
-in the string section (under schemas) where you discuss characters: I rephrased a line for additional clarity here, but if my edit has changed the meaning, please feel free to revise. I considered using “sub-restriction” but that felt a bit too… made-up? Lol. If you know of a word/phrase that gets at that idea, that would be best.
-I left comments in the Schema section, specifically for “URL” and “domain”, where a couple of links 404’d and I wasn’t sure where to find the correct link.