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.

Sign up for GitHub

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

Jump to bottom

CI,STYLE: add spell check? #38776

Merged
merged 2 commits into from
Dec 29, 2020
Merged

CI,STYLE: add spell check? #38776

merged 2 commits into from
Dec 29, 2020

Conversation

MarcoGorelli
Copy link
Member

IIRC it was suggested in a comment some time ago to use a spell checker, so I thought I'd make a little PR showing how codespell would work (for now just applied to pandas/core).

Is this something we'd want? False positives can be ignored in setup.cfg in the [codespell] section

@MarcoGorelli MarcoGorelli added the Code Style Code style, linting, code_checks label Dec 29, 2020
jreback
jreback requested changes Dec 29, 2020
View reviewed changes
Copy link
Contributor

@jreback jreback left a comment

Choose a reason for hiding this comment

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

comment, looks fine. i think we had this before but removed it, don't remember why.

pandas/core/reshape/pivot.py
@@ -740,7 +740,7 @@ def _build_names_mapper(
A row or column name is replaced if it is duplicate among the rows of the inputs,
among the columns of the inputs or between the rows and the columns.

Paramters
Parameters
Copy link
Contributor

Choose a reason for hiding this comment

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

need to fix the underline

Copy link
Contributor

Choose a reason for hiding this comment

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

i guess this is not public but still let's fix

@MarcoGorelli
Copy link
Member Author

MarcoGorelli commented Dec 29, 2020 •
edited
Loading

i think we had this before but removed it

I just ran git log -G codespell and got nothing (other than this PR)

I did however find (with git log -G spell) #24299, which removed sphinxcontrb.spelling. That's a different tool - this one (codespell) is very fast and takes ~0.7 seconds on the whole codebase from my (non-exceptional) laptop

@jreback
Copy link
Contributor

jreback commented Dec 29, 2020

i think we had this before but removed it

I just ran git log -G codespell and got nothing (other than this PR)

I did however find (with git log -G spell) #24299, which removed sphinxcontrb.spelling. That's a different tool - this one (codespell) is very fast and takes ~0.7 seconds on the whole codebase from my (non-exceptional) laptop

ahh right that was for the docs. okie this looks fine to me (we may want to even clean up the exclude list at some point as well, e.g. narrow it) but that's for other isssues.

@jreback jreback added this to the 1.3 milestone Dec 29, 2020
jreback
jreback reviewed Dec 29, 2020
View reviewed changes
setup.cfg
@@ -63,6 +63,9 @@ filterwarnings =
error:The SparseArray:FutureWarning
junit_family=xunit2

[codespell]
ignore-words-list=ba,blocs,coo,datas,fo,hist,nd,ser
Copy link
Contributor

Choose a reason for hiding this comment

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

these here, let's open an issue and try to fix some of these
maybe 'fo' rest might be ok

@jreback
Copy link
Contributor

jreback commented Dec 29, 2020

merge on green

@MarcoGorelli MarcoGorelli merged commit d201fcc into pandas-dev:master Dec 29, 2020
@MarcoGorelli MarcoGorelli deleted the codespell-core branch December 29, 2020 17:03
luckyvs1 pushed a commit to luckyvs1/pandas that referenced this pull request Jan 20, 2021
@MarcoGorelli @luckyvs1
CI,STYLE: add spell check? (pandas-dev#38776)
9b8641c 
* run codespell on pandas/core

* fix underline
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jreback jreback jreback approved these changes

Assignees
No one assigned
Labels
Code Style Code style, linting, code_checks
Projects
None yet
Milestone
1.3
Development

Successfully merging this pull request may close these issues.
2 participants
@MarcoGorelli @jreback