Skip to main content

pytest plugin to run pydocstyle

Project description

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

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-pydocstyle-2.3.0.tar.gz (4.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page