Enforce asterisk-style unordered lists#41
Merged
iansan5653 merged 3 commits intomainfrom Apr 26, 2023
Merged
Conversation
Collaborator
|
👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.
|
andrialexandrou
approved these changes
Apr 25, 2023
Collaborator
andrialexandrou
left a comment
There was a problem hiding this comment.
Repeating my comment from Slack:
I’m the likely candidate for the person who put that rule in the accessibility set, and if memory serves it was with the asterisk rule in mind. If it’s up to me we can merge this.
Approving.
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.
Asterisk style lists (ie,
* item) are preferred over other list styles because asterisks are most likely to be read out by screen readers. For example, given the following Markdown:VoiceOver on my machine reads:
Whereas with the following Markdown:
VoiceOver reads:
This makes it much less obvious that what is being read is actually a list.
The current configuration enables the
ul-stylerule, but by default this rule has thestyleparameter set toconsistent. This ensures that the list style is consistent across the whole file, based on the first encountered list item. What we really want isasterisk, which ensures that the list delimiter is always the*character.