8000 docs(eslint-plugin): switch check marks to `:white_check_mark:` for visibility by magurotuna · Pull Request #3277 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

docs(eslint-plugin): switch check marks to :white_check_mark: for visibility #3277

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 10, 2021
Merged

docs(eslint-plugin): switch check marks to :white_check_mark: for visibility #3277

merged 1 commit into from
Apr 10, 2021

Conversation

magurotuna
Copy link
Contributor
@magurotuna magurotuna commented Apr 10, 2021 •
edited
Loading

This patch switches :heavy_check_mark: to :white_check_mark: in the supported rules table.

The motivation for it is that :heavy_check_mark: (✔️) looks really indistinct in the dark themes.
As you can see in the following image, if visitors are using Dark dimmed theme, :heavy_check_mark: is very hard to recognize. (In particular, in the rows with a lighter background, such as the row of @typescript-eslint/ban-ts-comment, check marks are almost invisible)

Switching to :white_check_mark: (✅) should fix the issue (at least in my environment). In fact, the resulting table will look like:

image

which looks much better to me.
Of course, in the light theme and darker theme, it looks very nice too:

Default light theme

image

Default dark theme

image

For reference, here is the list of how :white_check_mark: looks like in various environments: https://emojipedia.org/check-mark-button/
And the rendered table can be seen here

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @magurotuna!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@magurotuna magurotuna changed the title docs(eslint-plugin): switch check marks to :white_check_mark:l for visibility docs(eslint-plugin): switch check marks to :white_check_mark: for visibility Apr 10, 2021
@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Apr 10, 2021
bradzacher
bradzacher approved these changes Apr 10, 2021
View reviewed changes
Copy link
Member
@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i like how it's called "white_check_mark" and yet it's green.

☑️ LGTM - thanks!

@bradzacher bradzacher merged commit a5836be into typescript-eslint:master Apr 10, 2021
@magurotuna magurotuna deleted the fix-check-mark branch April 11, 2021 06:10
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bradzacher bradzacher bradzacher approved these changes

Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@magurotuna @bradzacher
0