Add review bot tool for doc8
Review Request #9489 — Created Jan. 16, 2018 and submitted
doc8 is a style checker for Sphinx (or other)
RST documentation.doc8 is like flake8 for reStructuredText.
https://pypi.python.org/pypi/doc8
Uploaded a diff an .rst file as review request as saw that
it added some "errors" of this reStructuredText file.Uploaded a "clean" .rst file and saw that it did no
add any errors.
Description | From | Last Updated |
---|---|---|
Thanks for the contribution! Can you flesh out the description more to talk more about what the tool does and … |
chipx86 | |
Single quotes. |
brennie | |
"will not be listed" |
chipx86 | |
Can you bullet-proof this a bit, so that if we get some unexpected output, we'll log it and not just … |
chipx86 | |
It'd be nice to flesh this out a bit more, talk about what kind of things this looks for, and … |
chipx86 | |
"used text files" is weird. Maybe "Encoding used for rst files"? This also needs a period at the end. |
david | |
pass is unnecessary if there's another statement in the block. |
david | |
Reference here should be DOC8_ (which matches with the URL listed as _DOC8 |
david | |
Reference here should be RST_LINT_ We should also use :command:`doc8` instead of ``doc8`` |
david | |
No blank line here. |
david | |
Add a blank line here. |
david | |
Can get rid of the backticks around doc8 here. |
david | |
Please capitalize the first letter of each of these. |
david | |
Please capitalize the first letter of each of these. |
david | |
Like my comment elsewhere, none of the other documents have this, and it doesn't particularly add much value on top … |
david |
- Change Summary:
-
doc
- Commit:
-
55d4e4d9d0c9ef2bff42574529dcfbb2bf5f8cb1fcd86885ae76e768431b3bf049a88e68074361d1
Checks run (2 succeeded)
- Commit:
-
fcd86885ae76e768431b3bf049a88e68074361d1885aba428a0dd22db7e30643c82f9c00982a0c6b
Checks run (2 succeeded)
-
-
Thanks for the contribution!
Can you flesh out the description more to talk more about what the tool does and what it's checking for, at a high level?
-
-
Can you bullet-proof this a bit, so that if we get some unexpected output, we'll log it and not just crash?
-
It'd be nice to flesh this out a bit more, talk about what kind of things this looks for, and also to have a link to the page.
Should also have a section on configuring the tool.
- Summary:
-
Add tool for doc8Add review bot tool for doc8
- Description:
-
~ Style checker for Sphinx (or other) RST documentation.
~ https://pypi.python.org/pypi/doc8 ~ doc8 is a style checker for Sphinx (or other)
~ RST documentation. + + doc8 is like flake8 for reStructuredText.
+ + https://pypi.python.org/pypi/doc8
- Testing Done:
-
Uploaded a diff an .rst file as review request as saw that
it added some "errors" of this reStructuredText file. + + Uploaded a "clean" .rst file and saw that it did no
+ add any errors. - Commit:
-
885aba428a0dd22db7e30643c82f9c00982a0c6bf470a58640af38bfe70fbc6ef7dae301bcd63a7a
Checks run (2 succeeded)
- Commit:
-
f470a58640af38bfe70fbc6ef7dae301bcd63a7aecc8199422e377d49910e0af092cf37be374c73f