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

Fix typos in PEPs using codespell #3909

Merged
merged 9 commits into from
Aug 20, 2024
Merged

Conversation

corneliusroemer
Copy link
Contributor

@corneliusroemer corneliusroemer commented Aug 18, 2024

It seems codespell was last run on peps up to around 481, since there's only one typo up to pep 100 and many thereafter.

Is this ok or do I need to make a separate PR for each PEP? That would be 18 which would be a bit annoying but I can do it if there should be no exception to the rule.

I ran codespell from main (commit codespell-project/codespell@f8e1b5f) with the following invokation:

codespell --write-changes -i3 --check-hidden --check-filenames

📚 Documentation preview 📚: https://pep-previews--3909.org.readthedocs.build/

Copy link

cpython-cla-bot bot commented Aug 18, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@corneliusroemer corneliusroemer changed the title Fixing a bunch of typos using codespell Fixing 18 typos in 18 PEPs using codespell Aug 18, 2024
@corneliusroemer corneliusroemer marked this pull request as draft August 18, 2024 16:40
peps/pep-0506.rst Outdated Show resolved Hide resolved
@Rosuav
Copy link
Contributor

Rosuav commented Aug 18, 2024

IMO these are all small changes - a bunch of simple and non-controversial spelling corrections, plus associated infrastructure - so I'm fine with it all being one PR. There's one false positive, but otherwise LGTM.

peps/pep-0506.rst Outdated Show resolved Hide resolved
@corneliusroemer corneliusroemer marked this pull request as ready for review August 18, 2024 16:46
Copy link
Member

@savannahostrowski savannahostrowski left a comment

Choose a reason for hiding this comment

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

Thanks, these LGTM!

@hugovk hugovk changed the title Fixing 18 typos in 18 PEPs using codespell Fix typos in PEPs using codespell Aug 18, 2024
peps/pep-0540.rst Outdated Show resolved Hide resolved
.codespell/ignore-words.txt Outdated Show resolved Hide resolved
@hugovk hugovk mentioned this pull request Aug 18, 2024
.codespell/exclude-file.txt Outdated Show resolved Hide resolved
@corneliusroemer
Copy link
Contributor Author

Note: In addition to the changes requested/suggested by @AA-Turner and @hugovk in review, I've added the extra ignore directories: build/, .venv/ and .ruff_cache.

build/ gave false positives, but I wasn't aware of that because I hadn't yet built when I ran codespell when I made the PR. I'm sure this is uncontroversial - codespell shouldn't spellcheck generated files.

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@hugovk hugovk merged commit 89ae6e0 into python:main Aug 20, 2024
6 checks passed
@corneliusroemer corneliusroemer deleted the codespell-typos branch August 20, 2024 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants