PEP 257

What is PEP 257?

The Python PEP 257 docstring style checker is a static analysis tool that verifies compliance with the Python PEP 257 standard for docstring formatting. It provides a flexible framework for checking docstring style, enabling the addition of custom checks to accommodate conventions such as those used in the NumPy project. The tool supports a wide range of Python versions, including 2.6, 2.7, 3.3, 3.4, 3.5, as well as the PyPy and PyPy3 implementations

Highlights

• Verifies adherence to Python PEP 257 docstring style guidelines
• Flexible framework allows for the addition of custom checks to enforce specific conventions (e.g., NumPy docstring style)
• Supports a broad range of Python versions, including 2.6, 2.7, 3.3, 3.4, 3.5, PyPy, and PyPy3
• Open-source tool available on PyPI and GitHub