Skip to content

hugueskamba/pydocstyle

This branch is 132 commits behind PyCQA/pydocstyle:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

792b8d9 · Jan 6, 2019
Jan 6, 2019
Oct 27, 2018
Oct 27, 2018
Oct 15, 2018
Oct 14, 2018
Oct 20, 2018
Jan 6, 2019
Oct 14, 2018
Jan 24, 2017
Jan 23, 2014
Aug 23, 2018
Oct 14, 2018
Sep 6, 2016
Oct 15, 2018
Oct 20, 2018

Repository files navigation

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

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 and 3.7.

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

About

docstring style checker

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%