Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove non-semantic visual code formatting #463

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jugglinmike
Copy link
Contributor

A number of text files in this repository use empty space characters in
places where they have no technical significance. This practice is
generally followed to vertically align information when text is rendered
visually. For users of assistive technologies, it may not be apparent
that this practice is being followed, and it may be burdensome to
maintain the convention.

Remove the formatting to promote equity in the project's contribution
experience.


git diff and git show accept a flag -w which hides changes that only impact empty space. That's a useful feature to review patches like this because it helps demonstrate that there aren't any unintended changes amidst all the reformatting.

A number of text files in this repository use empty space characters in
places where they have no technical significance. This practice is
generally followed to vertically align information when text is rendered
visually. For users of assistive technologies, it may not be apparent
that this practice is being followed, and it may be burdensome to
maintain the convention.

Remove the formatting to promote equity in the project's contribution
experience.
@jscholes
Copy link
Contributor

@jugglinmike Thanks for taking care of this. I would also ask, along the same lines, that we don't use hard line wrapping in PR or issue comments either, which exhibits the same problem. I.e. my screen reader can't present the text with the configured line length if it includes hard returns at a certain number of columns. Thanks 👍

@jugglinmike
Copy link
Contributor Author

Thanks for letting me know! I'll take care to avoid hard line wrapping when posting to GitHub.

@mzgoddard mzgoddard mentioned this pull request Sep 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants