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 codespell as a linter #5265

Merged
merged 14 commits into from
Mar 14, 2023
Merged

Add codespell as a linter #5265

merged 14 commits into from
Mar 14, 2023

Conversation

benfred
Copy link
Member

@benfred benfred commented Mar 9, 2023

Similar to rapidsai/cudf#12097, this adds codespell as a linter to the pre-commit config, and fixes various spelling errors it highlights. (https://github.com/codespell-project/codespell)

Similar to rapidsai/cudf#12097, this adds codespell
as a linter to the pre-commit config, and fixes various spelling errors
it highlights. (https://github.com/codespell-project/codespell)
@benfred benfred requested review from a team as code owners March 9, 2023 19:57
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@csadorf csadorf added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Mar 13, 2023
Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

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

Very nice! I like that we can use this pre-commit hook to more easily avoid these kind of common mistakes in the future.

I went through all changes and found a few spurious and wrong ones, I would appreciate if you could address those.

Further, I think it would be good to add a summary of the hooks' purpose to the contributor guide here. It would also be great to have a brief note with guidance on how to disable the check for specific words or lines.

python/cuml/cluster/hdbscan/hdbscan.pyx Outdated Show resolved Hide resolved
python/cuml/ensemble/randomforestclassifier.pyx Outdated Show resolved Hide resolved
python/cuml/explainer/kernel_shap.pyx Outdated Show resolved Hide resolved
python/cuml/tests/test_linear_svm.py Outdated Show resolved Hide resolved
cpp/src/tsne/cannylab/bh.cu Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
benfred and others added 4 commits March 13, 2023 10:26
Co-authored-by: Carl Simon Adorf <[email protected]>
and comments to the codespell config describing what the options do
Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

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

Great, thanks for addressing the review comments so quickly. It would still be nice if you could add a note about how to ignore certain suggestion (# noqa ?) to the contributor guide, otherwise LGTM!

@benfred
Copy link
Member Author

benfred commented Mar 13, 2023

Great, thanks for addressing the review comments so quickly. It would still be nice if you could add a note about how to ignore certain suggestion (# noqa ?) to the contributor guide, otherwise LGTM!

thanks @csadorf ! I've added some text about how to ignore suggestions in the last commit

@vyasr
Copy link
Contributor

vyasr commented Mar 14, 2023

/merge

@rapids-bot rapids-bot bot merged commit d41a081 into rapidsai:branch-23.04 Mar 14, 2023
@benfred benfred deleted the codespell branch March 14, 2023 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci CMake CUDA/C++ Cython / Python Cython or Python issue improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants