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.

Sign up for GitHub

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 typos #1647

Merged
merged 1 commit into from
Apr 15, 2018
Merged

Fix typos #1647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ There are three places to get help:
Badge guidelines
----------------

- The left-hand side of a badge should not advertize. It should be a *noun*
- The left-hand side of a badge should not advertise. It should be a *noun*
succinctly describing the meaning of the right-hand side.
- Query parameters must be *declared by the service*. See `request-handler.js`.
- Except for badges using the `social` style, logos should be *turned off by
Expand Down
4 changes: 2 additions & 2 deletions doc/TUTORIAL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,12 +173,12 @@ The following numbering explains what happens in the corresponding lines.
The `url` is created to query the API.
5. Create the basic badge to use.
You can read about the [different formats available][format].
It contains the format for all responses, regarless of the API's response.
It contains the format for all responses, regardless of the API's response.
6. We request the `url` and pass a call back function to the request.
The function is called once the data is retrieved from the API.
7. We want to always see a badge regardless the input.
In some cases the API may return an error e.g. if the query was invalid.
The error is handled and a badge with the the status "inaccessible" is returned.
The error is handled and a badge with the status "inaccessible" is returned.
![](https://img.shields.io/badge/docker%20build-inaccessible-lightgrey.svg)
8. The data returned by the API as JSON is parsed.
9. Based on the result, the text and the color of the badge are altered.
Expand Down