Add codespell as a linter #12097

benfred · 2022-11-09T01:36:21Z

Description

This adds codespell as a linter to the pre-commit config, and fixes various spelling errors it identifies (https://github.com/codespell-project/codespell)

Checklist

I am familiar with the Contributing Guidelines.
New or existing tests cover these changes.
The documentation is up to date with these changes.

This adds codespell as a linter to the pre-commit config, and fixes various spelling errors it identifies (https://github.com/codespell-project/codespell)

bdice · 2022-11-09T01:43:51Z

setup.cfg

+
+[codespell]
+skip = ./.git,./.github,./cpp/build,.*egg-info.*,versioneer.py,./.mypy_cache,./cpp/tests,./python/cudf/cudf/tests
+ignore-words-list = inout,indext,offsett,dout,unparseable,incase,afterall,fiter,trings


This list is not that long! 💯

I'm cheating a bit and ignoring the tests =)

(The tests have some test data in there that was messing it up - but wasn't really typos)

I think that’s reasonable. We can always expand later if we wish. The errors fixed in this PR are worthwhile even if not covering the whole repo.

You probably could add ./java/src/test to this list and then remove trings
And add ./cpp/include/cudf_test/cxxopts.hpp and then remove fiter.
I'm not finding indext or afterall in the code.
Is offsett in here because of offsetted? Maybe those can be corrected.

Also, should the skip list include ./python/cudf/_skbuild and ./python/strings_udf/_skbuild as well?
How about __pycache__?
Is there any way this could use the .gitignore files so we do not have to maintain both?

I believe cxxopts.hpp is vendored and that file should be ignored rather than edited. I believe that specific name fiter is supposed to mean “format iterator” and is not a typo.

Then it should not be linted at all.
If you look at the history for cxxopts.hpp it has been modified it several times.
I realize fiter is not a typo but it seems odd to create an exception for it for the entire repo.
Either we should not lint this file or we should fix it.

I agree with David that we should not lint this file. (My previous comment may have been unclear.)

I've removed the cxxopts.hpp from linting - and applied @wence- suggestion about the ignore regex to exclude template params types. The ignore-words list is down to just inout,unparseable now, and I think those are both valid words myself.

Perfect! That's ideal.

bdice

Nice @benfred! I'd support including this hook.

galipremsagar

Love this code spell linter addition ❤️

davidwendt · 2022-11-09T12:49:17Z

ok to test

review-notebook-app · 2022-11-09T19:21:56Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

codecov · 2022-11-09T21:50:21Z

Codecov Report

❗ No coverage uploaded for pull request base (branch-23.02@b743f2f). Click here to learn what that means.
Patch has no changes to coverable lines.

Additional details and impacted files

@@               Coverage Diff               @@
##             branch-23.02   #12097   +/-   ##
===============================================
  Coverage                ?   88.24%           
===============================================
  Files                   ?      137           
  Lines                   ?    22586           
  Branches                ?        0           
===============================================
  Hits                    ?    19931           
  Misses                  ?     2655           
  Partials                ?        0

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

wence-

Yes, thanks!

* use ignore-regex to exclude template params like OffsetT * slim down list of ignore-words to just inout/unparseable * exclude ./cpp/include/cudf_test/cxxopts.hpp

bdice · 2022-11-18T13:38:46Z

@gpucibot merge

benfred · 2022-11-18T18:41:50Z

rerun tests

bdice · 2022-11-21T20:27:36Z

I changed (and reset) the target branch so that the Branch Checker CI would be unblocked. It looks like CI will need to re-run, then this can be merged.

bdice · 2022-11-21T20:28:21Z

@gpucibot merge

galipremsagar · 2022-11-21T20:31:25Z

rerun tests

ttnghia · 2022-11-22T02:44:25Z

Fix typo in ChunkedReaderJni.cpp

OMG I can't know why I've made that typo. I swear that I stared at that comment many times before merging 😂

Exclude the changelog from the pre-commit changelog - this is to prevent CI failures after release when the changelog is updated, as suggested here rapidsai/cudf#12097 (review) This also exports the `__version__` for pylibraft / raft_dask, which was missing previously

Exclude the changelog from the pre-commit codespell check- this is to prevent CI failures after release when the changelog is updated, as suggested here rapidsai/cudf#12097 (review) This also exports the `__version__` for pylibraft / raft_dask, which was missing previously Authors: - Ben Frederickson (https://github.com/benfred) Approvers: - Corey J. Nolet (https://github.com/cjnolet) URL: #1083

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) Authors: - Ben Frederickson (https://github.com/benfred) Approvers: - Carl Simon Adorf (https://github.com/csadorf) - William Hicks (https://github.com/wphicks) - Joseph (https://github.com/jolorunyomi) - Vyas Ramasubramani (https://github.com/vyasr) URL: #5265

Following the example of rapidsai/cudf#12097, this PR adds [codespell](https://github.com/codespell-project/codespell) as a linter for rmm. Note: I have not included a section in the CONTRIBUTING.md about how to use this (as was done in cudf's PR) because I plan to overhaul the contributing guides for all RAPIDS repos in the near term, and have a single source in docs.rapids.ai with common information about linters used in RAPIDS. Authors: - Bradley Dice (https://github.com/bdice) Approvers: - Rong Ou (https://github.com/rongou) - Ben Frederickson (https://github.com/benfred) - Mark Harris (https://github.com/harrism) URL: #1231

Following the example of rapidsai/cudf#12097, this PR adds [codespell](https://github.com/codespell-project/codespell) as a linter for cuspatial. Note: I have not included a section in the CONTRIBUTING.md about how to use this (as was done in cudf's PR) because I plan to overhaul the contributing guides for all RAPIDS repos in the near term, and have a single source in docs.rapids.ai with common information about linters used in RAPIDS. Authors: - Bradley Dice (https://github.com/bdice) Approvers: - Mark Harris (https://github.com/harrism) - Michael Wang (https://github.com/isVoid) - Ray Douglass (https://github.com/raydouglass) URL: #992

Following the example of rapidsai/cudf#12097, this PR adds [codespell](https://github.com/codespell-project/codespell) as a linter for cuspatial. Note: I have not included a section in the CONTRIBUTING.md about how to use this (as was done in cudf's PR) because I plan to overhaul the contributing guides for all RAPIDS repos in the near term, and have a single source in docs.rapids.ai with common information about linters used in RAPIDS. Authors: - Bradley Dice (https://github.com/bdice) Approvers: - Mark Harris (https://github.com/harrism) - Michael Wang (https://github.com/isVoid) - Ray Douglass (https://github.com/raydouglass) URL: rapidsai#992

Add codespell as a linter

8511b65

This adds codespell as a linter to the pre-commit config, and fixes various spelling errors it identifies (https://github.com/codespell-project/codespell)

bdice reviewed Nov 9, 2022

View reviewed changes

bdice approved these changes Nov 9, 2022

View reviewed changes

galipremsagar approved these changes Nov 9, 2022

View reviewed changes

davidwendt added 3 - Ready for Review Ready for review by team improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Nov 9, 2022

benfred added 2 commits November 9, 2022 11:09

Update copyright

3e14c61

Fix codespell errors from pre-commit

213d222

benfred requested review from a team as code owners November 9, 2022 19:21

benfred requested review from vyasr, isVoid and ttnghia November 9, 2022 19:21

github-actions bot added CMake CMake build issue Java Affects Java cuDF API. Python Affects Python cuDF API. libcudf Affects libcudf (C++/CUDA) code. labels Nov 9, 2022

davidwendt requested a review from vuule November 9, 2022 19:33

ttnghia approved these changes Nov 9, 2022

View reviewed changes

benfred added 3 commits November 9, 2022 14:24

remove afterall

f5512f5

Merge branch 'branch-22.12' into codespell

74db768

Fix typo in dask_cudf/io/json.py

e3adec5

wence- approved these changes Nov 10, 2022

View reviewed changes

Apply suggestions from code-review

28370f4

* use ignore-regex to exclude template params like OffsetT * slim down list of ignore-words to just inout/unparseable * exclude ./cpp/include/cudf_test/cxxopts.hpp

bdice changed the base branch from branch-22.12 to branch-23.02 November 18, 2022 13:32

Merge remote-tracking branch 'upstream/branch-23.02' into codespell

2278bc6

bdice changed the base branch from branch-23.02 to branch-22.12 November 21, 2022 20:26

bdice requested review from a team as code owners November 21, 2022 20:26

bdice changed the base branch from branch-22.12 to branch-23.02 November 21, 2022 20:26

bdice removed request for a team November 21, 2022 20:27

benfred added 2 commits November 21, 2022 16:37

Merge remote-tracking branch 'origin/branch-23.02' into codespell

00f810e

Fix typo in ChunkedReaderJni.cpp

dde04c5

rapids-bot bot merged commit d49e412 into rapidsai:branch-23.02 Nov 22, 2022

benfred deleted the codespell branch November 22, 2022 05:25

benfred mentioned this pull request Dec 8, 2022

Exclude changelog from pre-commit spellcheck rapidsai/raft#1083

Merged

benfred mentioned this pull request Mar 9, 2023

Add codespell as a linter rapidsai/cuml#5265

Merged

This was referenced Mar 14, 2023

Add codespell as a linter rapidsai/rmm#1231

Merged

Add codespell as a linter rapidsai/cuspatial#992

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add codespell as a linter #12097

Add codespell as a linter #12097

benfred commented Nov 9, 2022

bdice Nov 9, 2022

benfred Nov 9, 2022

bdice Nov 9, 2022

davidwendt Nov 9, 2022 •

edited

Loading

davidwendt Nov 9, 2022 •

edited

Loading

bdice Nov 10, 2022 •

edited

Loading

davidwendt Nov 10, 2022

bdice Nov 10, 2022

benfred Nov 10, 2022

bdice Nov 10, 2022

bdice left a comment

galipremsagar left a comment

davidwendt commented Nov 9, 2022

review-notebook-app bot commented Nov 9, 2022

codecov bot commented Nov 9, 2022 •

edited

Loading

wence- left a comment

bdice commented Nov 18, 2022

benfred commented Nov 18, 2022

bdice commented Nov 21, 2022

bdice commented Nov 21, 2022

galipremsagar commented Nov 21, 2022

ttnghia commented Nov 22, 2022 •

edited

Loading

Add codespell as a linter #12097

Add codespell as a linter #12097

Conversation

benfred commented Nov 9, 2022

Description

Checklist

bdice Nov 9, 2022

Choose a reason for hiding this comment

benfred Nov 9, 2022

Choose a reason for hiding this comment

bdice Nov 9, 2022

Choose a reason for hiding this comment

davidwendt Nov 9, 2022 • edited Loading

Choose a reason for hiding this comment

davidwendt Nov 9, 2022 • edited Loading

Choose a reason for hiding this comment

bdice Nov 10, 2022 • edited Loading

Choose a reason for hiding this comment

davidwendt Nov 10, 2022

Choose a reason for hiding this comment

bdice Nov 10, 2022

Choose a reason for hiding this comment

benfred Nov 10, 2022

Choose a reason for hiding this comment

bdice Nov 10, 2022

Choose a reason for hiding this comment

bdice left a comment

Choose a reason for hiding this comment

galipremsagar left a comment

Choose a reason for hiding this comment

davidwendt commented Nov 9, 2022

review-notebook-app bot commented Nov 9, 2022

codecov bot commented Nov 9, 2022 • edited Loading

Codecov Report

wence- left a comment

Choose a reason for hiding this comment

bdice commented Nov 18, 2022

benfred commented Nov 18, 2022

bdice commented Nov 21, 2022

bdice commented Nov 21, 2022

galipremsagar commented Nov 21, 2022

ttnghia commented Nov 22, 2022 • edited Loading

davidwendt Nov 9, 2022 •

edited

Loading

davidwendt Nov 9, 2022 •

edited

Loading

bdice Nov 10, 2022 •

edited

Loading

codecov bot commented Nov 9, 2022 •

edited

Loading

ttnghia commented Nov 22, 2022 •

edited

Loading