Wooey icon indicating copy to clipboard operation
Wooey copied to clipboard

Auto-loading of documentation from script text blocks

Open mfitzp opened this issue 9 years ago • 1 comments

Add support for importing blocks of text documentation from the header of scripts in Python block text format. This might be something better handled in clinto (?) though it's not directly related to argparsing.

Blocks like those found in this file would be pulled out. We can probably achieve this with some simple regex/file parsing looking for triple-quoted strings """ in the top-level of the script.

mfitzp avatar Aug 27 '15 19:08 mfitzp

Looking into this it appears that you can pull out the top-level documentation from a script using import x; x.__doc__ so this is even easier.

mfitzp avatar Sep 07 '15 09:09 mfitzp