fix: Clarify 'No missing headings' summary text - #7811
Open
Modusensus (modusensus) wants to merge 1 commit into
Open
Modusensus (modusensus) wants to merge 1 commit into
Modusensus (modusensus) wants to merge 1 commit into
Conversation
Update the requirement description, how-to-test instructions, and associated guidance content to describe headings by their function (labels a section of the page) rather than their appearance, reducing false positives and avoiding the common misconception that headings should be used for text formatting. Sync affected test snapshots. Addresses microsoft#7762
Author
|
@microsoft-github-policy-service agree |
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
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.
Details
Clarifies the summary text for the "No missing headings" requirement (#7762). The previous wording ("Text that looks like a heading must be coded as a heading") can be confusing or misleading, since it can feed into the common misconception that headings should be used to format text. The new wording describes headings by their function instead of their appearance.
New wording:
This change touches:
Motivation
Addresses #7762
Pull request checklist
yarn fastpassyarn test)fix:,chore:,feat(feature-name):,refactor:). SeeCONTRIBUTING.md.