Skip to main content

pytest plugin to run pydocstyle

Project description

pytest-docstyle

PyPI version

pytest plugin to run pydocstyle

Installation

pip install pytest-docstyle

Usage

pytest --docstyle ...

For detail, please see pytest -h after installation.

Configuration

You can configure options of pydocstyle with setup.cfg (or pytest.ini).
(cf. Configuration — pytest documentation)

For example,

[tool:pytest]
docstyle_convention = numpy
docstyle_add_ignore = D400 D403

Licence

The MIT License
Copyright (c) 2017 Tsukasa OMOTO

Acknowledgments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-docstyle-1.3.1.tar.gz (3.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page