Summary

Add review bot tool for doc8

Review Request #9489 — Created Jan. 16, 2018 and submitted

Information

Owner

misery

Repository

ReviewBot

Branch

release-1.0.x

Bugs

Depends On

Reviewers

Groups

reviewbot

People

Description

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.

Issues

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	Jan. 19, 2018, 3:43 p.m.
Single quotes.	brennie	Jan. 19, 2018, 11:36 a.m.
"will not be listed"	chipx86	Jan. 19, 2018, 3:12 p.m.
Can you bullet-proof this a bit, so that if we get some unexpected output, we'll log it and not just …	chipx86	Jan. 19, 2018, 3:36 p.m.
It'd be nice to flesh this out a bit more, talk about what kind of things this looks for, and …	chipx86	Jan. 19, 2018, 3:27 p.m.
"used text files" is weird. Maybe "Encoding used for rst files"? This also needs a period at the end.	david	Jan. 24, 2018, 11:39 p.m.
pass is unnecessary if there's another statement in the block.	david	Jan. 24, 2018, 11:39 p.m.
Reference here should be DOC8_ (which matches with the URL listed as _DOC8	david	Jan. 24, 2018, 11:40 p.m.
Reference here should be RST_LINT_ We should also use :command:`doc8` instead of ``doc8``	david	Jan. 24, 2018, 11:40 p.m.
No blank line here.	david	Jan. 24, 2018, 11:40 p.m.
Add a blank line here.	david	Jan. 24, 2018, 11:41 p.m.
Can get rid of the backticks around doc8 here.	david	Jan. 24, 2018, 11:41 p.m.
Please capitalize the first letter of each of these.	david	Jan. 24, 2018, 11:41 p.m.
Please capitalize the first letter of each of these.	david	Jan. 24, 2018, 11:41 p.m.
Like my comment elsewhere, none of the other documents have this, and it doesn't particularly add much value on top …	david	Jan. 24, 2018, 11:41 p.m.

flake8 passed.

JSHint passed.

Change Summary:

doc

Commit:

55d4e4d9d0c9ef2bff42574529dcfbb2bf5f8cb1

fcd86885ae76e768431b3bf049a88e68074361d1

Diff:

Revision 2 (+122)

Show changes

	bot/setup.py
	bot/reviewbot/tools/doc8.py
	docs/reviewbot/reviewbot/tools/doc8.rst
	docs/reviewbot/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

```
One tiny nit. This looks great!
```
bot/reviewbot/tools/doc8.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Single quotes.
```

Commit:

fcd86885ae76e768431b3bf049a88e68074361d1

885aba428a0dd22db7e30643c82f9c00982a0c6b

Diff:

Revision 3 (+122)

Show changes

	bot/setup.py
	bot/reviewbot/tools/doc8.py
	docs/reviewbot/reviewbot/tools/doc8.rst
	docs/reviewbot/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

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?

bot/reviewbot/tools/doc8.py (Diff revision 3)
The issue has been resolved. Show all issues
```
"will not be listed"
```
1. misery Jan. 19, 2018, 3:51 p.m.
  https://reviews.reviewboard.org/r/9500/ :-)

bot/reviewbot/tools/doc8.py (Diff revision 3)

The issue has been resolved. Show all issues

Can you bullet-proof this a bit, so that if we get some unexpected output, we'll log it and not just crash?

docs/reviewbot/reviewbot/tools/doc8.rst (Diff revision 3)

The issue has been resolved. Show all issues

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 doc8

Add 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:

885aba428a0dd22db7e30643c82f9c00982a0c6b

f470a58640af38bfe70fbc6ef7dae301bcd63a7a

Diff:

Revision 4 (+137)

Show changes

	bot/setup.py
	bot/reviewbot/tools/doc8.py
	docs/reviewbot/reviewbot/tools/doc8.rst
	docs/reviewbot/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

bot/reviewbot/tools/doc8.py (Diff revision 4)

The issue has been resolved. Show all issues

"used text files" is weird. Maybe "Encoding used for rst files"?

This also needs a period at the end.

bot/reviewbot/tools/doc8.py (Diff revision 4)
The issue has been resolved. Show all issues
```
pass is unnecessary if there's another statement in the block.
```
docs/reviewbot/reviewbot/tools/doc8.rst (Diff revision 4)
The issue has been resolved. Show all issues
```
Reference here should be DOC8_ (which matches with the URL listed as _DOC8
```

docs/reviewbot/reviewbot/tools/doc8.rst (Diff revision 4)

The issue has been resolved. Show all issues

Reference here should be RST_LINT_

We should also use :command:`doc8` instead of ``doc8``

docs/reviewbot/reviewbot/tools/doc8.rst (Diff revision 4)
The issue has been resolved. Show all issues
```
No blank line here.
```
docs/reviewbot/reviewbot/tools/doc8.rst (Diff revision 4)
The issue has been resolved. Show all issues
```
Add a blank line here.
```
docs/reviewbot/reviewbot/tools/doc8.rst (Diff revision 4)
The issue has been resolved. Show all issues
```
Can get rid of the backticks around doc8 here.
```
docs/reviewbot/reviewbot/tools/doc8.rst (Diff revision 4)
The issue has been resolved. Show all issues
```
Please capitalize the first letter of each of these.
```
docs/reviewbot/reviewbot/tools/doc8.rst (Diff revision 4)
The issue has been resolved. Show all issues
```
Please capitalize the first letter of each of these.
```

docs/reviewbot/reviewbot/tools/doc8.rst (Diff revision 4)

The issue has been resolved. Show all issues

Like my comment elsewhere, none of the other documents have this, and it doesn't particularly add much value on top of the UI.

Commit:

f470a58640af38bfe70fbc6ef7dae301bcd63a7a

ecc8199422e377d49910e0af092cf37be374c73f

Diff:

Revision 5 (+129)

Show changes

	bot/setup.py
	bot/reviewbot/tools/doc8.py
	docs/reviewbot/reviewbot/tools/doc8.rst
	docs/reviewbot/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

rebase

Branch:

master

release-1.0.x

Commit:

ecc8199422e377d49910e0af092cf37be374c73f

0d044d9008b38d4189edac4a7d4e8ee26d421fea

Diff:

Revision 6 (+129)

Show changes

	bot/setup.py
	bot/reviewbot/tools/doc8.py
	docs/reviewbot/tools/doc8.rst
	docs/reviewbot/tools/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Status:: Discarded

Status:: Re-opened

Status:: Discarded

Ship it!

```
Ship It!
```

Status:: Re-opened

Status:: Completed
Change Summary:: Pushed to master (ff05573)