Skip to content

Lint: Check spelling on CI but don't fail #3080

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 30, 2023
Merged

Lint: Check spelling on CI but don't fail #3080

merged 1 commit into from
Mar 30, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Mar 30, 2023 •
edited by github-actions bot
Loading

  • Check spelling on the CI, but don't fail the CI, so we can check output for PRs
  • Fix a typo in the rendering system docs
  • Add "dedented" and "falsy" to ignored words list: they're always fine
  • Ignore the specific lines that contain "pullrequest", "ClassE", "inout": they're fine in those instances

For reference, the remainder all look valid:

pep-0653.rst:596: stategy ==> strategy
pep-0526.txt:467: undocummented ==> undocumented
pep-0697.rst:340: retreive ==> retrieve
pep-0665.rst:58: producting ==> producing, production
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-0622.rst:2110: equilvalent ==> equivalent
pep-0011.txt:45: plaforms ==> platforms
pep-0582.rst:47: depenencies ==> dependencies
pep-0683.rst:27: implmentation ==> implementation
pep-0683.rst:706: speicific ==> specific
pep-0426.txt:1287: overal ==> overall
pep-0652.rst:245: aded ==> added
pep-0677.rst:1023: ot ==> to, of, or, not
pep-0677.rst:1118: compatiblity ==> compatibility
pep-0701.rst:379: withing ==> within
pep-0701.rst:439: withing ==> within
pep-0285.txt:418: redability ==> readability
pep-0708.rst:126: similiar ==> similar
pep-0670.rst:524: retreive ==> retrieve
pep-0689.rst:42: requring ==> requiring
pep-0689.rst:133: exeption ==> exception, exemption
pep-0691.rst:87: reponses ==> responses
pep-0669.rst:118: Ancilliary ==> Ancillary
pep-0669.rst:420: 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--3080.org.readthedocs.build/

@hugovk hugovk added the meta Related to the repo itself and its processes label Mar 30, 2023
@hugovk hugovk requested review from CAM-Gerlach, AA-Turner and a team as code owners March 30, 2023 14:51
@CAM-Gerlach CAM-Gerlach added lint Linter-related work and linting fixes on PEPs and removed meta Related to the repo itself and its processes labels Mar 30, 2023
CAM-Gerlach
CAM-Gerlach approved these changes Mar 30, 2023
View reviewed changes
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, though I'm not sure how many people will actually dig into the passing check output to see this. Would be more useful as a bot comment listing typos in changed files, or as non-gating check annotations with the same, but up to you if you want to go to that effort :)

@CAM-Gerlach CAM-Gerlach changed the title Meta: Check spelling on CI but don't fail Lint: Check spelling on CI but don't fail Mar 30, 2023
@hugovk
Copy link
Member Author

hugovk commented Mar 30, 2023

Yeah, could annotate like the CPython docs warning checker and only for changed PR files. Although I'm a little hesitant for spellchecker as sometimes it complains about valid spellings, and we might not want to spam those. But then again, it's only annotations and they can be added to the ignore lists.

Well, will consider for future work!

@hugovk hugovk merged commit 3028f07 into python:main Mar 30, 2023
@hugovk hugovk deleted the spelling branch March 30, 2023 16:52
@AA-Turner AA-Turner mentioned this pull request Apr 30, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CAM-Gerlach CAM-Gerlach CAM-Gerlach approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees
No one assigned
Labels
lint Linter-related work and linting fixes on PEPs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hugovk @CAM-Gerlach