Skip to content

Fix ReST linters warnings #7650

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 3 commits into from
Oct 7, 2019
Merged

Fix ReST linters warnings #7650

merged 3 commits into from
Oct 7, 2019

Conversation

hoefling
Copy link
Contributor

@hoefling hoefling commented Oct 7, 2019

  • single backticks don't produce verbatim text in ReST (reported by rst-backticks hook)
  • cleaned up whitespaces reported by doc8

This is part of splitting up the changes in #7624 into more readable PRs.

@hoefling
fixed markdown backticks
e080f3d 
Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
@hoefling
cleaned up trailing whitespaces reported by doc8
8605ad3 
Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
@JelleZijlstra
Copy link
Member

Is there something we could do in CI to make sure we don't reintroduce warnings like this later?

@hoefling
Copy link
Contributor Author

hoefling commented Oct 7, 2019 •
edited
Loading

@JelleZijlstra For linting docs, I use the pre-commit hooks, so the subtle errors like trailing lines/spaces or wrong backticks are caught when committing locally. Then, the CI runs pre-commit run --all-files to execute the same hooks once in the CI job. Since mypy repo doesn't use pre-commit, I suppose the testenv:docs job could be extended with a doc8/rst-backticks checks run?

@hoefling
more markdown backticks not caught by rst-backticks
dc7704c 
Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
gvanrossum
gvanrossum approved these changes Oct 7, 2019
View reviewed changes
Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

+1, will merge.

I wouldn't approve a PR that just removed trailing spaces, but I will approve markup fixes like single backticks, and I don't mind a little extra noise in the PR.

@gvanrossum
Copy link
Member

I recall looking into the "pre-commit" tool and being baffled by its complexity.

Let's start by adding a script to lint docs and run it in from .travis.yml.

@gvanrossum gvanrossum merged commit 11df39f into python:master Oct 7, 2019
@hoefling hoefling deleted the markdown-fixes branch October 7, 2019 23:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

@gvanrossum gvanrossum gvanrossum approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hoefling @JelleZijlstra @gvanrossum
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy