pydocstyle’s documentation

pydocstyle is a static analysis tool for checking compliance with Python docstring conventions.

pydocstyle supports most of PEP 257 out of the box, but it should not be considered a reference implementation.

pydocstyle supports Python 3.4, 3.5, 3.6, 3.7, and pypy.

Quick Start

1. Install

   pip install pydocstyle
   

2. Run

   $ pydocstyle test.py
   test.py:18 in private nested class `meta`:
           D101: Docstring missing
   test.py:27 in public function `get_user`:
       D300: Use """triple double quotes""" (found '''-quotes)
   test:75 in public function `init_database`:
       D201: No blank lines allowed before function docstring (found 1)
   ...
   

3. Fix your code :)

Contents:

• Usage
  • Installation
  • Command Line Interface
  • Usage with the pre-commit git hooks framework
• Error Codes
  • Grouping
  • Default conventions
  • Publicity
• Release Notes
  • 4.0.0 - July 6th, 2019
  • 3.0.0 - October 14th, 2018
  • 2.1.1 - October 9th, 2017
  • 2.1.0 - October 8th, 2017
  • 2.0.0 - April 18th, 2017
  • 1.1.1 - October 4th, 2016
  • 1.1.0 - September 29th, 2016
  • 1.0.0 - January 30th, 2016
• Older Versions
  • 0.7.0 - October 9th, 2015
  • 0.6.0 - July 20th, 2015
  • 0.5.0 - March 14th, 2015
  • 0.4.1 - January 10th, 2015
  • 0.4.0 - January 4th, 2015
  • 0.3.2 - March 11th, 2014
• License

Credits

pydocstyle is a rename and continuation of pep257, a project created by Vladimir Keleshev.

Maintained by Amir Rachum.