Updated documentation.

github · Jan 16, 2025 · 18c44cf · 18c44cf
1 parent 77bcf3e
commit 18c44cf
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -128,7 +128,7 @@ For branch protection rules and rulesets, you can allow for status checks to be
 
 This can be defined at the org, sub-org, and repo level.
 
-To configure this for branch protection rules, specifiy `{{EXTERNALLY_DEFINED}}` under the `contexts` keyword:
+To configure this for branch protection rules, specify `{{EXTERNALLY_DEFINED}}` under the `contexts` keyword:
 ```yaml
 branches:
   - name: main

diff --git a/lib/plugins/overrides.js b/lib/plugins/overrides.js
@@ -21,8 +21,8 @@ module.exports = class Overrides extends ErrorStash {
   // When {{EXTERNALLY_DEFINED}} is found in the override value, retain the
   // existing value from GitHub.
   // Note:
-  //   - The admin settings could define multiple overrides, but the GitHub API
-  //     retains one only.
+  //   - The admin settings could define multiple status check rules for a
+  //     ruleset, but the GitHub API retains one only, i.e. the last one.
   //   - The PUT method for rulesets (update) allows for multiple overrides.
   //   - The POST method for rulesets (create) allows for one override only.
   static removeOverrides (overrides, source, existing) {