Documentation typos (#1647)
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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.
|
||||

|
||||
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.
|
||||
|
||||
Reference in New Issue
Block a user