Skip to content
docstring style checker
Python
Branch: master
Clone or download

Latest commit

samj1912 Fix bug with google style arg regex (#448)
Currently, due to the way the regex was specified, the regex
matcher was getting thrown off by types that used colons.

This change makes the regex robust to such type and fixes #443
Latest commit ac56b83 May 28, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Fix bug with google style arg regex (#448) May 28, 2020
requirements Fix appveyor builds (#415) Oct 21, 2019
src Fix bug with google style arg regex (#448) May 28, 2020
.appveyor.yml Support py38 (#423) Oct 23, 2019
.bumpversion.cfg Bump version: 5.0.2 → 5.0.3rc Jan 10, 2020
.gitignore Add an initial Google convention (#357) May 26, 2019
.pre-commit-hooks.yaml Add pre-commit hook #346 (#347) Jan 6, 2019
.travis.yml Support py38 (#423) Oct 23, 2019
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 Spelling fixes (#327) Aug 23, 2018
README.rst Add 3.8 to supported version. Dec 9, 2019
requirements.txt Merge branch 'master' into splitfiles Sep 6, 2016
setup.py Add Release Notes project URL (#471) May 5, 2020
tox.ini Support py38 (#423) Oct 23, 2019

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

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.5, 3.6, 3.7 and 3.8.

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

You can’t perform that action at this time.