Fix inconsistent rule-number heading format for rule 219 - #5
Open
simeon-kepp wants to merge 1 commit into
Open
Conversation
Every other rule heading in the guidelines wraps its reference number
in square brackets (e.g. "[218]", "[238]", "[126]"), but rule 219
("MUST provide API audience") was missing the brackets, reading as
"... API audience 219" instead of "... API audience [219]".
This is the only such inconsistency in the document (checked against
every "### ..." heading). The existing internal anchor link to this
section (#must-provide-api-audience-219) is unaffected, since
GitHub's heading-slug algorithm strips bracket characters either way.
Co-authored-by: Laura Serna Gaviria <lsgaviria94@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Every rule heading in the guidelines wraps its reference number in square brackets (e.g.
[218],[238],[126]), except rule 219 ("MUST provide API audience"), which reads... API audience 219instead of... API audience [219].Checked every
### ...heading in the document — this is the only instance of the inconsistency.Verification
[see rule 219](#must-provide-api-audience-219)still resolves correctly after this change, since GitHub's heading-slug algorithm strips bracket characters from anchors either way.Small fix, but we noticed it while reading through the guidelines closely for our own API work and figured a real government repo deserved a real (if tiny) contribution back. 🇨🇭