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

CI/STYLE extend codespell beyond pandas/core #38802

Closed
MarcoGorelli opened this issue Dec 30, 2020 · 12 comments · Fixed by #40372
Closed

CI/STYLE extend codespell beyond pandas/core #38802

MarcoGorelli opened this issue Dec 30, 2020 · 12 comments · Fixed by #40372
Labels
Code Style Code style, linting, code_checks Docs good first issue
Milestone

Comments

@MarcoGorelli
Copy link
Member

MarcoGorelli commented Dec 30, 2020

There is task left here:

  1. apply the following diff
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index d78c2bacc..bcb9202d4 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -173,4 +173,4 @@ repos:
     hooks:
     -   id: codespell
         types_or: [python, rst, markdown]
         files: ^(pandas|doc)/
-        exclude: ^pandas/tests/

, run pre-commit run codespell --all-files, and fixup the mistakes

You may need you to add new words to ignore in setup.cfg.

@MarcoGorelli MarcoGorelli added Docs Code Style Code style, linting, code_checks good first issue labels Dec 30, 2020
@chinggg
Copy link
Contributor

chinggg commented Dec 30, 2020

Hi! I am new to opensource and I want to take task 4.Do I just need to fork the repo and make a PR?
take

@chinggg
Copy link
Contributor

chinggg commented Dec 30, 2020

take

@MarcoGorelli
Copy link
Member Author

hey @chinggg - yup, the contributing guide explains everything https://pandas.pydata.org/pandas-docs/dev/development/contributing.html

@zitorelova
Copy link
Contributor

Hello, I would like to take on the 1st task.

@zitorelova
Copy link
Contributor

take

@jreback jreback added this to the 1.3 milestone Jan 21, 2021
@zitorelova zitorelova removed their assignment Jan 27, 2021
@MarcoGorelli
Copy link
Member Author

Have updated the tasks based on those which have already been done, in case any newcomers want to contribute

@bryanccho
Copy link

I will work on task 2

@bryanccho
Copy link

take

@01-vyom
Copy link
Contributor

01-vyom commented Mar 6, 2021

I am working on task 2 and cleaned pretty much everything, but I had a couple of doubts:

  1. .sav is caught in the codespell, and I don't know if I should include it in the ignore list.
    (https://github.com/pandas-dev/pandas/blob/master/doc/source/user_guide/io.rst#spss-formats)
  2. There is an example with the TIP.csv which has Thur which is caught in codespell, but as it part of the example I don't if it should be changed, and adding Thur to ignore-word-list doesn't seem feasible to me.
    (https://github.com/pandas-dev/pandas/blob/master/doc/source/getting_started/comparison/comparison_with_sql.rst)

Screenshot 2021-03-06 at 5 39 09 PM

@MarcoGorelli
Copy link
Member Author

Hey @01-vyom

For sav, I think we'll have to ignore it, I can't think of a way to avoid it.

For Thur, I'd say just change it to Thu in the examples

@01-vyom
Copy link
Contributor

01-vyom commented Mar 6, 2021

Ok going ahead with this plan, will make a PR soon.

@01-vyom
Copy link
Contributor

01-vyom commented Mar 9, 2021

Working on Task 1 and closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Style Code style, linting, code_checks Docs good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants