gleandoc 0.1.0

Simple convenience function to extract docstring

Simple convenience function to extract docstring

Examples

Print the first line of a docstring:

>>> import gleandoc
>>> docstring = gleandoc.docstring('re')
>>> docstring.splitlines()[0]
'Support for regular expressions (RE).'
>>>

Do the same thing from the command line:

$ gleandoc re | head -1
Support for regular expressions (RE).
$

Features

• No dependencies

Limitations

• Embedded backslash-n newlines are treated as actual newlines

• Relies on various pseudo-internals: locals(), exec()

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.