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

Lint: Fix outstanding codespell spelling errors #3129

Merged
merged 6 commits into from
May 1, 2023
Merged

Lint: Fix outstanding codespell spelling errors #3129

merged 6 commits into from
May 1, 2023

Conversation

arhadthedev
Copy link
Member

@arhadthedev arhadthedev commented Apr 30, 2023

https://github.com/python/peps/actions/runs/4843117521/jobs/8630554766?pr=3128#step:5:87:

Check for common misspellings in text files..............................Failed
- hook id: codespell
- exit code: 65

pep-0642.rst:1702: recenty ==> recently
pep-0205.txt:189: referencable ==> referenceable
pep-0205.txt:213: referencable ==> referenceable
pep-0205.txt:213: referencable ==> referenceable
pep-0582.rst:49: depenencies ==> dependencies
pep-0652.rst:245: aded ==> added
pep-0653.rst:596: stategy ==> strategy
pep-0701.rst:379: withing ==> within
pep-0701.rst:439: withing ==> within
pep-0011.txt:45: plaforms ==> platforms
pep-0622.rst:2110: equilvalent ==> equivalent
pep-0670.rst:524: retreive ==> retrieve
pep-0426.txt:1287: overal ==> overall
pep-0708.rst:126: similiar ==> similar
pep-0526.txt:467: undocummented ==> undocumented
pep-0665.rst:58: producting ==> producing, production
pep-0285.txt:418: redability ==> readability
pep-0683.rst:27: implmentation ==> implementation
pep-0683.rst:706: speicific ==> specific
pep-0677.rst:1023: ot ==> to, of, or, not
pep-0677.rst:1118: compatiblity ==> compatibility
pep-0689.rst:42: requring ==> requiring
pep-0689.rst:133: exeption ==> exception, exemption
pep-0691.rst:87: reponses ==> responses
pep-0669.rst:121: Ancilliary ==> Ancillary
pep-0669.rst:425: neglible ==> negligible
pep-0674.rst:404: sufficently ==> sufficiently
pep-0684.rst:674: allcoators ==> allocators
pep-0690.rst:296: dictionay ==> dictionary
pep-0706.rst:541: wth ==> with
pep-0706.rst:572: dilligent ==> diligent
pep-0554.rst:481: inteded ==> intended

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

@arhadthedev
Copy link
Member Author

arhadthedev commented Apr 30, 2023

I cannot uncheck reviewers added from CODEOWNERS so my apologises for making more noise than required.

@arhadthedev
Copy link
Member Author

Correction: I can but only after creating and undrafting a PR.

@arhadthedev arhadthedev changed the title Fix errors silently reported by Lint / Run pre-commit (pull_request) Fix errors reported silently by Lint / Run pre-commit (pull_request) Apr 30, 2023
@AA-Turner
Copy link
Member

To note, these were left unfixed in #3080, and we generally have a disinclination for mass typo-fix PRs. I'm not sure what the other editors think, though.

A

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.

Personally I'm fine with it, but as Adam said, we've generally avoided this sort of thing. And I recently suggested a typo fix to work around the repeated CI approval when iterating for a first-time contributor (#3095 (comment)).

But this PR is made now, we may as well merge it :)

pep-0205.txt Outdated Show resolved Hide resolved
@arhadthedev
Copy link
Member Author

arhadthedev commented Apr 30, 2023

we generally have a disinclination for mass typo-fix PRs

I hope it's a once-in-a-lifetime fix. After that, we can change .github/workflows/lint.yml to not allow new typos to creep in:

-          extra_args: --all-files --hook-stage manual codespell || true
+          extra_args: --all-files --hook-stage manual codespell

Edit: should I add the modification of lint.yml into this PR?

@hugovk
Copy link
Member

hugovk commented Apr 30, 2023

No thanks, when this was added, we didn't want to enforce spellcheck on CI due to false positives: #2075 (comment) / #2075 (comment) / #2151 (review) / #2151 (comment) / etc.

pep-0205.txt Outdated Show resolved Hide resolved
pep-0205.txt Outdated Show resolved Hide resolved
pep-0669.rst Outdated Show resolved Hide resolved
@arhadthedev arhadthedev requested a review from AA-Turner April 30, 2023 18:12
pep-0677.rst Outdated Show resolved Hide resolved
Co-authored-by: wookie184 <[email protected]>
pep-0689.rst Show resolved Hide resolved
@CAM-Gerlach CAM-Gerlach changed the title Fix errors reported silently by Lint / Run pre-commit (pull_request) Lint: Fix outstanding codespell spelling errors May 1, 2023
@CAM-Gerlach CAM-Gerlach added lint Linter-related work and linting fixes on PEPs and removed enhancement labels May 1, 2023
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

LGTM now, though seems like others have already done the hard work of reviewing this. As others have mentioned, we don't really want to encourage these kind of mass-typo-fix PR, but we may as well merge it. Hopefully they will be less common now that #3080 was implemented, though that thought might be rather optimistic and this will be a perpetual problem.

@hugovk hugovk merged commit b9ca714 into python:main May 1, 2023
@arhadthedev arhadthedev deleted the codespell-fix branch May 1, 2023 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lint Linter-related work and linting fixes on PEPs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants