/pydocstyle

docstring style checker
  1. Python 100.0%
Python
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit ac20e2c Dec 18, 2017 @lordmauve lordmauve committed with Nurdok Report docstring content violations on docstring line (#238) 
* Report docstring content violations on docstring start line (fixes #83)

* Add description of line number change to release notes

* Change title of development version in release notes

* Add issue and PR numbers to release notes
Permalink
Failed to load latest commit information.
docs Report docstring content violations on docstring line (#238) Dec 18, 2017
requirements #250 - Added configparser backport from py3 Sep 11, 2017
src Report docstring content violations on docstring line (#238) Dec 18, 2017
.appveyor.yml Adding dist installation tests to CI (#292) Oct 10, 2017
.bumpversion.cfg Bump version: 2.1.1 → 2.1.2rc Oct 9, 2017
.gitignore Added .venvs dir to .gitignore. Nov 27, 2016
.travis.yml Adding dist installation tests to CI (#292) Oct 10, 2017
LICENSE-MIT Update LICENSE-MIT Jan 24, 2017
MANIFEST.in Add MANIFEST.in so README.rst is rendered on PyPI Jan 23, 2014
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md Jun 20, 2017
README.rst Added classifiers for specific Python versions and a README badge. Oct 10, 2017
requirements.txt Merge branch 'master' into splitfiles Sep 6, 2016
setup.py Added classifiers for specific Python versions and a README badge. Oct 10, 2017
tox.ini Adding dist installation tests to CI (#292) Oct 10, 2017

README.rst

pydocstyle - docstring style checker

https://travis-ci.org/PyCQA/pydocstyle.svg?branch=master https://ci.appveyor.com/api/projects/status/40kkc366bmrrttca/branch/master?svg=true Documentation Status

(formerly pep257)

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 2.7, 3.3, 3.4, 3.5, 3.6 and pypy.

Quick Start

Install

pip install pydocstyle

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)
...

Links