doc-gen 0.0.1

How to use this library

This library has a shell script, doc, and a decorator, doc. Pretty easy to remember. To use this library, you have to decorate the functions which you want with doc, like so:

# source.py

@doc
def function(x, y):
     return 2 * x + y

Then, in the terminal, you should type doc source.py, and you should see a prompt asking you for a docstring for function.

After that, drop into the shell and check out the docstring of function:

>>> import source
>>> source.function.__doc__
'<whatever you wrote>'

Sweet, isn’t it?