[MRG] DEV: Add local codespell usage to dev install #977
Conversation
This file contains 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
jasmainak
approved these changes
Jan 24, 2025
asoplata
force-pushed
the
add-local-codespell
branch
from
a532219 to
f76425c
Compare
|
Force-push was only for the |
|
Force push as much as you want on feature branches! Just don't sin on the |
|
Absolutely! I would never :) |
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.
This is a pretty trivial change: this adds support for automatic local install and usage of codespell. This fixes an annoyance since, currently, we have a CI runner for
codespellusage (see https://github.com/codespell-project/codespell ), but there's no automatic local way to test for such spelling mistakes before you push your commits.This fixes the problem, in that now,
codespellis used the same as our linting: it's installed as part of the[test]or[dev]options (e.g.pip install "hnn_core[test]"), and run during a developer's localmake test. The TOML change also enables it to ignore any locally-built artifacts (which are not a problem for the CI runner).After this, hopefully no more follow-up "
flake8 fix" or "spelling mistake" commits :)