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

Add emojis to visually distinguish between hints and lints #770

Merged
merged 2 commits into from
Nov 9, 2024

Conversation

maresb
Copy link
Contributor

@maresb maresb commented Nov 9, 2024

Description

As I explain here it can be really easy to miss the distinction between hints and linting errors. (The difference is indicated in a big block of boilerplate text.) Using ℹ️ for hints and ❌ for linter errors, I hope to make this easier to understand the severity at a glance.

@maresb
Copy link
Contributor Author

maresb commented Nov 9, 2024

cc @beckermr

@maresb
Copy link
Contributor Author

maresb commented Nov 9, 2024

pre-commit.ci autofix

As I explain [here](conda-forge/conda-smithy#2126 (comment)) it can be really easy to miss the distinction between hints and linting errors. (The difference is indicated in a big block of boilerplate text.) Using ℹ️ for hints and ❌ for linter errors, I hope to make this easier to understand the severity at a glance.
@beckermr
Copy link
Member

beckermr commented Nov 9, 2024

This will potentially break some spacing hacks in hints with sub lists. Is there a way we can account for that with the emoji?

@maresb maresb changed the title Visually distinguish between hints and lints Add emojis to visually distinguish between hints and lints Nov 9, 2024
@maresb
Copy link
Contributor Author

maresb commented Nov 9, 2024

Hmm, can you point to an example so that I understand better?

@beckermr
Copy link
Member

beckermr commented Nov 9, 2024

See this link: conda-forge/conda-smithy#2126. I used a precise number of spaces to format things properly.

@beckermr
Copy link
Member

beckermr commented Nov 9, 2024

Also there are two linting paths. The one in use is the one in the GitHub actions integration submodule. We'll want to change that one too.

@maresb
Copy link
Contributor Author

maresb commented Nov 9, 2024

Thanks @beckermr! Regarding the sublists I think it still works without modification. I tested <SP>*<SP><EMOJI><SP><NL><SP><SP><SP>- ... here.

@maresb
Copy link
Contributor Author

maresb commented Nov 9, 2024

Also there are two linting paths. The one in use is the one in the GitHub actions integration submodule. We'll want to change that one too.

Thanks, got it in f79e381

@beckermr beckermr added this pull request to the merge queue Nov 9, 2024
Merged via the queue into conda-forge:main with commit 9a3e3d6 Nov 9, 2024
8 checks passed
@maresb maresb deleted the patch-1 branch November 9, 2024 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants