Skip to content

Add codespell pre-commit hook#9040

Merged
jcrist merged 2 commits intodask:mainfrom
jrbourbeau:codespell
May 5, 2022
Merged

Add codespell pre-commit hook#9040
jcrist merged 2 commits intodask:mainfrom
jrbourbeau:codespell

Conversation

@jrbourbeau
Copy link
Copy Markdown
Member

@jrbourbeau jrbourbeau commented May 5, 2022

This PR adds a new codespell pre-commit hook to catch some common spelling mistakes in our docs

cc @jsignell @scharlottej13 for thoughts

@github-actions github-actions bot added the documentation Improve or add to documentation label May 5, 2022
jrbourbeau
jrbourbeau commented May 5, 2022
View reviewed changes
.pre-commit-config.yaml
hooks:
- id: flake8
language_version: python3
- repo: https://github.com/codespell-project/codespell
Copy link
Copy Markdown
Member Author

@jrbourbeau jrbourbeau May 5, 2022

Choose a reason for hiding this comment

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

Totally open to using some other project. I just chose codespell because that's what pandas is using

bryanwweber
bryanwweber reviewed May 5, 2022
View reviewed changes
jcrist
jcrist approved these changes May 5, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@jcrist jcrist left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @jrbourbeau!

@jcrist jcrist merged commit afe1e06 into dask:main May 5, 2022
@jrbourbeau jrbourbeau deleted the codespell branch May 6, 2022 02:13
@jrbourbeau jrbourbeau mentioned this pull request May 6, 2022
Merged
erayaslan pushed a commit to erayaslan/dask that referenced this pull request May 12, 2022
@jrbourbeau @jcrist @erayaslan
Add codespell pre-commit hook (dask#9040)
ab304aa 
* Add codespell pre-commit

* Fix missing newline in setup.cfg

Co-authored-by: Jim Crist-Harif <jcristharif@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jcrist jcrist jcrist approved these changes

+1 more reviewer

@bryanwweber bryanwweber bryanwweber left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improve or add to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jrbourbeau @jcrist @bryanwweber