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: Enable spellcheck in docbuild #21354

Closed
TomAugspurger opened this issue Jun 7, 2018 · 9 comments
Closed

CI: Enable spellcheck in docbuild #21354

TomAugspurger opened this issue Jun 7, 2018 · 9 comments
Labels
CI Continuous Integration Docs good first issue

Comments

@TomAugspurger
Copy link
Contributor

Followup to #21109

We'll need to refactor scripts/announce.py to update the list of contributors on each build.

Then we can enable spellcheck in the Travis doc build.

@daminisatya
Copy link
Contributor

Is this issue still open? @TomAugspurger

@FabioRosado
Copy link
Contributor

I would like to take on this since this is related to my previous PR 😄

@FabioRosado
Copy link
Contributor

@daminisatya Apologies I had this tab open and your comment didnt show but you beat me to it so if you would like to take on this issue go ahead 😄 👍

@WillAyd
Copy link
Member

WillAyd commented Jun 7, 2018

@daminisatya since you marked interest in this and the JSON issue how about you tackle the JSON one as a first contribution and let @FabioRosado continue with this one, since this is a logical follow up to a change he just made?

@daminisatya
Copy link
Contributor

Yes @WillAyd, I was about to comment the same :) @FabioRosado you can go ahead with the issue since you have already solved it you will have a better context than me! I took up another first-timer issue.

@jbrockmendel jbrockmendel added the CI Continuous Integration label Jul 15, 2018
@afeld
Copy link
Member

afeld commented Feb 17, 2021

Update: Appears this was added and then subsequently removed. In #24287, the comment that:

The spellcheck system was implemented, but with dependencies (i.e. enchant) that are no longer maintained, and there is no reasonable way to set them up.

doesn't seem to be true anymore. I'm seeing releases for both enchant and pyenchant in December 2020. In other words, I think we should consider adding spellcheck back in.

@afeld
Copy link
Member

afeld commented Feb 17, 2021

Currently we run codespell on the source code, minus the test suite.

- id: codespell
types_or: [python, rst, markdown]
files: ^pandas/
exclude: ^pandas/tests/

We could expand it to the docs and see how it compares…?

@MarcoGorelli
Copy link
Member

@afeld yes, there's an open issue about that #38802

@afeld
Copy link
Member

afeld commented Feb 18, 2021

Seems like the issues are duplicates, so closing this one for now.

@afeld afeld closed this as completed Feb 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Docs good first issue
Projects
None yet
Development

No branches or pull requests

7 participants