Skip to content

README.md

Latest commit

 

History

History
44 lines (32 loc) · 912 Bytes

README.md

File metadata and controls

44 lines (32 loc) · 912 Bytes
Raw

docstringr.py

For the lazy.

Automatically generates numpy-style docstrings for Python scripts and inserts them into the source code using lib2to3.

First proof of concept, feel free to adapt. If you have made changes that you would like to contribute, just create a pull request.

Some type guessing is done if parameters have default values. Generated docstrings have the following format:

"""
Missing documentation

Parameters
----------
param1 : Type
    Description
param2 : Type, optional
    Description (default None)

Returns
-------
Value : Type
    Description
"""

Usage

python gen_docstrings.py PATH_TO_PYTHON_FILES

Recursively (!) lists all .py files in directory and inserts docstrings at function bodies, writing result to file suffixed with _docstringed.

TODO

  • Respect existing docstrings
  • More flexibility
  • Other docstring formats (Google, ..)