1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
pydocstyle's documentation
==========================
**pydocstyle** is a static analysis tool for checking compliance with Python
docstring conventions.
**pydocstyle** supports most of
`PEP 257 <http://www.python.org/dev/peps/pep-0257/>`_ out of the box, but it
should not be considered a reference implementation.
**pydocstyle** supports Python 2.7, 3.3, 3.4, 3.5 and pypy.
.. include:: quickstart.rst
Contents:
.. toctree::
:maxdepth: 2
usage
error_codes
Credits
=======
pydocstyle is a rename and continuation of pep257, a project created by
Vladimir Keleshev.
Maintained by Amir Rachum.
|
