Skip to main content

Check for reStructuredText function parameter documentation

Project description

README #

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.2.tar.gz (3.0 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