piccolbo / docblock-python

Atom plugin to insert documentation blocks for python functions

Python DocBlock Package

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

Instalation

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

Available styles

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

TODO

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

• Add Google style
• Scan for Exceptions
• Convert between styles
• Add support for Type Hints (PEP 484)