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

Fix formatting in table headers for better accessibility #9312

Merged
merged 3 commits into from
Jan 21, 2025

Conversation

hichemfantar
Copy link
Contributor

Eliminate unnecessary italics for better readability because italics in general negatively affect legibility

you can see how the first header looks much more readable compared to the other two. testing this and then we can apply the fix to the rest of the documentation.

image

related to elixir-lang/ex_doc#2039

@CLAassistant
Copy link

CLAassistant commented Jan 19, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Jan 19, 2025

CT Test Results

   10 files    304 suites   3h 57m 0s ⏱️
4 177 tests 3 849 ✅ 326 💤 2 ❌
5 485 runs  5 080 ✅ 403 💤 2 ❌

For more details on these failures, see this check.

Results for commit c3679fc.

♻️ This comment has been updated with latest results.

To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass.

See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally.

Artifacts

// Erlang/OTP Github Action Bot

@garazdawi
Copy link
Contributor

Agreed, thanks for fixing. When I did a git grep "^| _" I found 40 other tables using the same convention. Would you mind fixing those as well so that we get consistence across the code base?

@rickard-green rickard-green added the team:VM Assigned to OTP team VM label Jan 20, 2025
@garazdawi garazdawi self-assigned this Jan 20, 2025
@hichemfantar
Copy link
Contributor Author

hichemfantar commented Jan 20, 2025

used this regex to find all instances \|\s*_([^_]+)_\s*\| and did a couple of runs for it to replace everything
replaced with | $1 | and formatted everything

i checked for mistakes and everything looks good but you should probably take a look too

@garazdawi
Copy link
Contributor

I looked through it and everything looks good. Thanks!

@garazdawi garazdawi merged commit 9111fcd into erlang:master Jan 21, 2025
31 of 33 checks passed
@hichemfantar hichemfantar deleted the better-table-headers branch January 21, 2025 14:45
@hichemfantar hichemfantar changed the title Fix formatting in system principles documentation table Fix formatting in table headers for better accessibility Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team:VM Assigned to OTP team VM
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants