docs(docs/.style/style-guide): fix self-violating examples - #27849
Merged
Conversation
Two internal-consistency fixes in the prose style guide: - The directional-language section in accessibility-and-inclusion.md used "See the [Latin abbreviations rule]" as a Do example and recommended "see the following section" in its replacements table. Both violate the navigational-"see" ban that word-choice.md applies to all docs. Reword to "refer to". - The one-sentence-per-line Do and Don't examples in formatting.md were byte-identical single source lines, so the Don't examples showed no violation. Blockquotes re-join lines when rendered, which hid the problem. Convert the examples to fenced md blocks that show the actual source line breaks. Assisted-by: AI
nickvigilante
marked this pull request as ready for review
August 4, 2026 15:18
This was referenced Aug 4, 2026
bpmct
approved these changes
Aug 4, 2026
earapo13
approved these changes
Aug 4, 2026
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Two internal-consistency fixes in the prose style guide, found while auditing it against ASD-STE100 (Simplified Technical English).
The directional-language section in
accessibility-and-inclusion.mdused "See the [Latin abbreviations rule]" as a Do example and recommended "see the following section" in its replacements table. Both violate the navigational-"see" ban thatword-choice.mdapplies to all docs, so the examples now use "refer to".The one-sentence-per-line Do and Don't examples in
formatting.mdwere byte-identical single source lines, so the Don't examples demonstrated no violation. Blockquotes re-join lines when rendered, which is why the broken examples went unnoticed. The examples are now fencedmdblocks that show the actual source line breaks (clause breaks and fixed-column wrap).🤖 Built with AI assistance.