Skip to main content

Check for reStructuredText function parameter documentation

Project description

Flake8 check for missing parameter RST documentation in Python based projects.

Install

From source

git clone git@bitbucket.org:jakobsg/flake8-rst-docparams.git
cd flake8-rst-docparams.git
python3 setup.py install

From PyPi

pip install flake8-rst-docparams

Setup with Tox

[testenv:flake8]
basepython = python3
skip_install = true
deps =
    flake8
    flake8-rst-docparams
commands =
    flake8

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

flake8-rst-docparams-1.0.7.tar.gz (3.3 kB view details)

Uploaded Source

File details

Details for the file flake8-rst-docparams-1.0.7.tar.gz.

File metadata

  • Download URL: flake8-rst-docparams-1.0.7.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for flake8-rst-docparams-1.0.7.tar.gz
Algorithm Hash digest
SHA256 184f0097f21a8fae31bdaefada65a015cbcce40f61623fe9f70f2c589b082631
MD5 298ea2c1a7b3e1d33a4a0c6258aee74f
BLAKE2b-256 d74a8398c40e6aa94a6463b7fa1872aeb2120c26567e4e8dc6914cbe8ef55689

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