-
Notifications
You must be signed in to change notification settings - Fork 59
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
Spellchecking with codespell #1576
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
* The `codespell` library is now a development dependency for the `dev` installation recipe with configurations found within `pyproject.toml`. This is also now a linting step and integrated as a `pre-commit` hook. For more information, see the `codespell documentation <https://github.com/codespell-project/codespell>`_ (:pull:`1576`). | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to know: Is the dev
installation automatically used when git cloning xclim and doing mamba install -n my_env -f environment.yml
? I think xscen
has environment_dev.yml
, but not xclim
, so how does this work here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's how we've organized xclim
here. When someone installs xclim
into a conda
environment with the dev
recipe, it pulls the development libraries from PyPI. This hasn't been an issue to date, but if we wanted to mirror the xscen
approach, adding this file into the codebase is feasible.
Perhaps worth discussing in a separate issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see a problem with this organization, I just wanted to understand it, to be sure I'm not using a wrong version by error.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice to have. Seems to be working well, approved!
Note: There were some changes like x -> x
. codespell does not make suggestions like this correct, just some unrelated completely manual changes while we're at it correct?
Pull Request Checklist:
number
) and pull request (:pull:number
) has been addedWhat kind of change does this PR introduce?
codespell
for checking word spellingscodespell
to ignore several French words and all current translations configurations.pre-commit
hook for performing these checks on commitDoes this PR introduce a breaking change?
Yes,
codespell
is now a development dependency.Other information:
https://github.com/codespell-project/codespell