search

henry0312 / pytest-pydocstyle

pytest plugin to run pydocstyle
MIT License
14 stars 3 forks source link
pytest pytest-plugin python python3

readme

pytest-pydocstyle

PyPI version

pytest plugin to run pydocstyle

Installation

pip install pytest-pydocstyle

Usage

pytest --pydocstyle ...

For detail, please see pytest -h after installation.

Configuration

The behavior can be configured in the same style of pydocstyle.
(cf. Configuration — pytest documentation and Configuration Files — pydocstyle documentation)

For example,

[pydocstyle]
convention = numpy
add-ignore = D400,D403

[tool:pytest]
addopts = --pydocstyle

Licence

The MIT License
Copyright (c) 2019 OMOTO Tsukasa

Acknowledgments