Skip to content
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

Fix some little typos... #44

Merged
merged 5 commits into from
May 21, 2019
Merged

Conversation

garethsb
Copy link
Contributor

Resolves #40, and the 'number/Temperature' examples referred to in #30, and

  • capitalize 'REST', 'API', 'WebSocket', 'QoS', 'URL' and 'URI' consistently
  • use 'Events API' consistently to refer to the REST API
  • use back-ticks consistently e.g. to format JSON field names/examples within sentences
  • format JSON message examples more consistently
  • reduce use of 'will' and 'will be' to talk about the spec's defined behaviours, replacing with 'must' or, most often, just 'is' (there are still more where I'm not entirely certain the spec means MUST...)
  • remove trailing double spaces (which force a break) where redundant

If the above tweaks are too many, we can adjust the PR...

* capitalize 'REST', 'API', 'WebSocket', 'QoS', 'URL' and 'URI' consistently
* use 'Events API' consistently to refer to the REST API
* use back-ticks consistently e.g. to format JSON field names/examples within sentences
* format JSON message examples more consistently
* reduce use of 'will' and 'will be' to talk about the spec's defined behaviours, replacing with 'must' or, most often, just 'is' (there are still more...)
* remove trailing double spaces (which force a break) where redundant
Copy link
Contributor

@mjeras mjeras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, but it would be good for @cristian-recoseanu to have a look before merging as Cristian prepared the original documentation (I am ok with the schema changes)

@mjeras mjeras requested a review from cristian-recoseanu May 14, 2019 12:55
@garethsb garethsb mentioned this pull request May 16, 2019
@mjeras
Copy link
Contributor

mjeras commented May 21, 2019

Can we please go with "temperature" rather than "Temperature"

Copy link
Contributor

@cristian-recoseanu cristian-recoseanu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@garethsb garethsb merged commit d1a3367 into AMWA-TV:v1.0.x May 21, 2019
garethsb added a commit that referenced this pull request May 21, 2019
….x, addressing review comment #44 (comment) to use lowercase 'temperature' in example event types.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

little typos
3 participants