Skip to content

Flake8 plugin for the pep257 Python utility for validating docstrings.

License

Notifications You must be signed in to change notification settings

bobh66/flake8-pep257

 
 

Repository files navigation

flake8-pep257

This is just a simple flake8 plugin for the pep257 Python utility for validating docstrings.

  • Python 2.6, 2.7, PyPy, PyPy3, 3.3, 3.4, and 3.5 supported on Linux and OS X.
  • Python 2.7, 3.3, 3.4, and 3.5 supported on Windows (both 32 and 64 bit versions of Python).
Build Status Windows Build Status Coverage Status Latest Version Downloads

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.5 - 2015-11-29

Fixed
  • Standard input (piped in data) bug.

1.0.4 - 2015-11-14

Fixed
  • pep257 v0.7.0 compatibility.

1.0.3 - 2015-05-31

Fixed
  • unicode bug.

1.0.2 - 2015-04-04

Fixed
  • setup.py requirements bug.

1.0.0 - 2015-04-04

  • Initial release.

About

Flake8 plugin for the pep257 Python utility for validating docstrings.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%