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 --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-docstyle-2.0.1.tar.gz (4.1 kB view details)

Uploaded Source

File details

Details for the file pytest-docstyle-2.0.1.tar.gz.

File metadata

  • Download URL: pytest-docstyle-2.0.1.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.7

File hashes

Hashes for pytest-docstyle-2.0.1.tar.gz
Algorithm Hash digest
SHA256 66b523677d8ed5f5b061ba0d216d46420ec85b492083e8e80bc6ea5fd6164f3b
MD5 8a0911544b2e1531fa8d593f7e1da741
BLAKE2b-256 d992a841948d831db8f51671dd121f7a835cc1d56dd517761995dc65a8a9745c

See more details on using hashes here.

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