Flake8 plugin for the pep257 Python utility.
Project description
This is just a simple flake8 plugin for the pep257 Python utility for validating docstrings.
Python 2.6, 2.7, PyPy, PyPy3, 3.3, and 3.4 supported on Linux and OS X.
Python 2.7, 3.3, and 3.4 supported on Windows (both 32 and 64 bit versions of Python).
Quickstart
Install:
pip install flake8-pep257
Run:
flake8
Error Codes
List of error codes are available here: http://pep257.readthedocs.org/en/latest/error_codes.html
Configuration
Settings may be specified in tox.ini (under the [flake8] or [pep257] sections), setup.cfg, and/or .pep257. Refer to this page for more information.
When specifying settings in tox.ini under the [flake8] section, use show-source instead of source and show-pep257 instead of explain.
Changelog
This project adheres to Semantic Versioning.
1.0.2 - 2015-04-04
Fixed setup.py requirements bug.
1.0.0 - 2015-04-04
Initial release.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.