From c7317a87fcb4632977f1d228c128a7ea55c5b8d8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C4=93teris=20Caune?= <cuu508@gmail.com>
Date: Thu, 19 Aug 2021 13:00:42 +0300
Subject: [PATCH] Improve /api/v1/badges/ docs

---
 templates/docs/api.html | 6 +++---
 templates/docs/api.md   | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/templates/docs/api.html b/templates/docs/api.html
index 70512685..8aeabba6 100644
--- a/templates/docs/api.html
+++ b/templates/docs/api.html
@@ -816,8 +816,8 @@ number of returned pings depends on the account's billing plan: 100 for free acc
 
 <h2 class="rule" id="list-badges">Get Project's Badges</h2>
 <p><code>GET SITE_ROOT/api/v1/badges/</code></p>
-<p>Returns a map of all tags in the project, with badge URLs for each tag. For each tag,
-SITE_NAME provides badges in a few different formats:</p>
+<p>Returns a map of all tags in the project, with badge URLs for each tag. SITE_NAME
+provides badges in a few different formats:</p>
 <ul>
 <li><code>svg</code>: returns the badge as a SVG document.</li>
 <li><code>json</code>: returns a JSON document which you can use to generate a custom badge
@@ -830,7 +830,7 @@ SITE_NAME provides badges in a few different formats:</p>
     considers any checks in the grace period as still "up".</li>
 <li><code>svg3</code>, <code>json3</code>, <code>shields3</code>: reports three states: "up", "late", and "down".</li>
 </ul>
-<p>The response includes a special <code>*</code> tag: this tag reports the overal status
+<p>The response includes a special <code>*</code> entry: this pseudo-tag reports the overal status
 of all checks in the project.</p>
 <h3>Response Codes</h3>
 <dl>
diff --git a/templates/docs/api.md b/templates/docs/api.md
index 287663e8..978f46e9 100644
--- a/templates/docs/api.md
+++ b/templates/docs/api.md
@@ -953,8 +953,8 @@ curl --header "X-Api-Key: your-api-key" SITE_ROOT/api/v1/channels/
 
 `GET SITE_ROOT/api/v1/badges/`
 
-Returns a map of all tags in the project, with badge URLs for each tag. For each tag,
-SITE_NAME provides badges in a few different formats:
+Returns a map of all tags in the project, with badge URLs for each tag. SITE_NAME
+provides badges in a few different formats:
 
 * `svg`: returns the badge as a SVG document.
 * `json`: returns a JSON document which you can use to generate a custom badge
@@ -967,7 +967,7 @@ In addition, badges have 2-state and 3-state variations:
     considers any checks in the grace period as still "up".
 * `svg3`, `json3`, `shields3`: reports three states: "up", "late", and "down".
 
-The response includes a special `*` tag: this tag reports the overal status
+The response includes a special `*` entry: this pseudo-tag reports the overal status
 of all checks in the project.
 
 ### Response Codes