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

Rst linting #285

Merged
merged 2 commits into from
Sep 6, 2024
Merged

Rst linting #285

merged 2 commits into from
Sep 6, 2024

Conversation

jakkdl
Copy link
Member

@jakkdl jakkdl commented Sep 6, 2024

Fixes #282 (comment)
Adds https://pypi.org/project/sphinx-lint/ and fixes all errors pointed out by it.
Also fixing a broken bullet list I manually noticed

I did not add any of the following linters, but that could be revisited

  • https://github.com/rstcheck/rstcheck which pointed out the markdown url in changelog.rst, but it was otherwise very noisy and didn't point out any actual errors.

  • https://github.com/PyCQA/doc8 complains about a ton of lines being too long, so if we want to stick with a max char line length it's the tool to go for. I personally feel it's got much less of an upside compared to code, and can be a major hassle to reflow lines after editing them instead of just letting autowrap handle it.

  • https://github.com/twolfson/restructuredtext-lint appears to have very few and very specific rules (that I'm guessing are mostly covered by one or more of the above linters)

Copy link
Member

@Zac-HD Zac-HD left a comment

Choose a reason for hiding this comment

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

Nice!

@Zac-HD Zac-HD merged commit 50bae03 into python-trio:main Sep 6, 2024
10 checks passed
@jakkdl jakkdl deleted the rst_linting branch September 9, 2024 12:49
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.

2 participants