Add pydocstyle tool to ReviewBot

Review Request #10197 — Created Oct. 4, 2018 and updated

ilaw
ReviewBot
master
3427151...
reviewbot, students

Users can now configure ReviewBot 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 installed

Tested pydocstyle by adding new configuration to ReviewBot integration
and publishing a review. Also tested with errors added to ignore list.

  • 0
  • 0
  • 7
  • 7
  • 14
Description From Last Updated
Checks run (1 failed, 1 succeeded)
flake8 failed.
JSHint passed.

flake8

ilaw
brennie
  1. 
      
  2. bot/reviewbot/tools/pydocstyle.py (Diff revision 2)
     
     

    Can you add a module-level docstring describing what the file is/does?

    1. Should I make it the same as the class-level docstring ("""Review Bot tool to run pydocstyle.""") which is what flake8.py does?

  3. bot/reviewbot/tools/pydocstyle.py (Diff revision 2)
     
     

    "PEP 257"

  4. 
      
brennie
  1. 
      
  2. bot/setup.py (Diff revision 2)
     
     

    This patch should build upon your previous patch and add pydocstyle to the all extra_requires section.

  3. 
      
ilaw
Review request changed

Commit:

-422c783bd814e8c2185bac26595a559f25182580
+342715177b87d03f7e2d8eb89ac5af06801d1e56

Diff:

Revision 3 (+81)

Show changes

Checks run (2 succeeded)

flake8 passed.
JSHint passed.
Loading...