Normative language improvements #158
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
peterbrightwell
force-pushed
the
docs-language
branch
from
403fcb1
to
048aa9e
Compare
garethsb
reviewed
Apr 1, 2021
Co-authored-by: Gareth Sylvester-Bradley <31761158+garethsb@users.noreply.github.com>
garethsb
reviewed
Apr 2, 2021
Co-authored-by: Gareth Sylvester-Bradley <31761158+garethsb@users.noreply.github.com>
garethsb
reviewed
Apr 2, 2021
peterbrightwell
commented
Apr 2, 2021
peterbrightwell
commented
Apr 2, 2021
peterbrightwell
commented
Apr 2, 2021
peterbrightwell
commented
Apr 2, 2021
peterbrightwell
commented
Apr 2, 2021
Co-authored-by: Gareth Sylvester-Bradley <31761158+garethsb@users.noreply.github.com>
garethsb
reviewed
Apr 2, 2021
* Using backticks in 2.1 * Backticks for 2.3, 2.4, 2.5 * Backticks for 3.0,3.1,3.2 * Backticks for 4.2,4.3 * Backticks for 5.1,6.0 * backticks for GET etc * Headers * Colons * HTTP verbs * More backtick/quote/apostrophe fixes * Add description consistently to all specific HTTP status codes in the docs. * i.e. id est * Don't use capitals for emphasis (apart from conformance language key words) * Attributes are within resources not the path... * More backticks on query parameters and HTTP headers * More backticks on attributes and URL path components * Backtick JSON keywords `null`, `true` and `false` Co-authored-by: garethsb <gareth.sylvester-bradley@sony.com>
* Backtick HTTP return codes * Backtick HTTP return codes in CHANGELOG * Apply suggestions from code review Co-authored-by: garethsb <gareth.sylvester-bradley@sony.com>
|
Things that I think are outstanding:
|
andrewbonney
reviewed
Apr 7, 2021
Sync example URL with IS-05 PR.
peterbrightwell
commented
Apr 7, 2021
garethsb
reviewed
Apr 8, 2021
Co-authored-by: Andrew Bonney <andrew.bonney@bbc.co.uk>
peterbrightwell
commented
Apr 12, 2021
peterbrightwell
commented
Apr 12, 2021
peterbrightwell
commented
Apr 12, 2021
|
AMWA-TV/is-template#19 suggests a style guide |
* Possible alternative language on Query API Behaviour * Suggested changes to Query API WebSocket Subscriptions documentation * Capitalizing Subscription Co-authored-by: Gareth Sylvester-Bradley <31761158+garethsb@users.noreply.github.com>
garethsb
reviewed
May 4, 2021
garethsb
reviewed
May 4, 2021
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.
Normative terms (MUST, SHOULD, MAY, etc.) are now all capitalised. Non-normative uses of those terms (which were mostly lower-case) have been replaced or rephrased.
Some other language improvements also included and a little reformatting.