DocBlock is a package for Atom which helps you to document your python code.

This experimental feature should show you when the documentation is not up-to-date. At the moment, it only checks if the current parameters and attributes are documented (not if you are documenting something that doesn't exist).

In order to this feature to work, you need to install Linter and enable the option in docblock-python settings.

From the command line run apm install docblock-python. You can also install it from the Atom Package manager.

• Numpy style: A Guide to NumPy/SciPy Documentation.
• Google style: Google Python Style Guide.
• Sphinx style: Sphinx documentation.
• Epytext style: Epytext documentation.

This is a non-exhaustive list of future additions. If you have any suggestions, drop me an email.

• Add Google style
• Add Sphinx style
• Scan for Exceptions
• Convert between styles
• Add support for Type Hints (PEP 484)
• Add lint support to show incomplete documentation