Add pydocstyle tool to Review Bot
Review Request #10197 — Created Oct. 5, 2018 and submitted — Latest diff uploaded
Users can now configure Review Bot to run pydocstyle, a tool for checking
compliance with Python docstring conventions.Pydocstyle is not added to the install requires list and users will
need to manually install it to use it.Pydocstyle defaults to using the PEP 257 docstring convention but users
can add a list of errors to ignore which will override the convention.
Tested dependency check by running reviewbot worker command without
pydocstyle installedTested pydocstyle by adding new configuration to Review Bot integration
and publishing a review. Also tested with errors added to ignore list.
README.rst | |||
---|---|---|---|
Revision ad339411b7239aa459187b73719c29a55166119f | New Change | ||
51 lines | |||
52 | 52 | ||
53 |
* `pycodestyle
|
53 |
* `pycodestyle
|
54 |
<https://www.reviewboard.org/docs/reviewbot/latest/tools/pycodestyle/>`_ |
54 |
<https://www.reviewboard.org/docs/reviewbot/latest/tools/pycodestyle/>`_ |
55 |
A code style checker for Python code |
55 |
A code style checker for Python code |
56 | 56 | ||
57 |
* `pydocstyle
|
||
58 |
<https://www.reviewboard.org/docs/reviewbot/latest/tools/pydocstyle/>`_ |
||
59 |
A static analysis tool for Python docstring conventions |
||
60 | |||
57 |
* `pyflakes <https://www.reviewboard.org/docs/reviewbot/latest/tools/pyflakes/>`_ |
61 |
* `pyflakes <https://www.reviewboard.org/docs/reviewbot/latest/tools/pyflakes/>`_ |
58 |
A static analysis tool for Python code |
62 |
A static analysis tool for Python code |
59 | 63 | ||
60 |
See the links above for installation and usage instructions. |
64 |
See the links above for installation and usage instructions. |
61 | 65 | ||
99 lines |
bot/README.rst |
---|
bot/reviewbot/tools/pydocstyle.py |
---|
docs/reviewbot/tools/index.rst |
---|
docs/reviewbot/tools/pydocstyle.rst |
---|
extension/README.rst |
---|