From 2ded83f8a68cd36102167883d0f9008a7404cb24 Mon Sep 17 00:00:00 2001 From: Thomas Broadley Date: Sun, 15 Apr 2018 15:43:51 -0400 Subject: [PATCH] Documentation typos (#1647) --- CONTRIBUTING.md | 2 +- doc/TUTORIAL.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58b40911f4..291cd2009f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/doc/TUTORIAL.md b/doc/TUTORIAL.md index 0ceb1e624f..61ab36d086 100644 --- a/doc/TUTORIAL.md +++ b/doc/TUTORIAL.md @@ -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.