Make automated documentation in recipes better |
|||||||||||||
Issue descriptionWe have a couple sources for in-code documentation: * We have docstrings on recipe module classes, module documentation, and method documentation * We can read module-level docstrings on a per-recipe basis * We can now document properties (using PROPERTIES), and can discover the full set of properties that a given recipe will respond to We should tie this all together into a nice `recipes.py help --recipe recipe_name` and `recipes.py help --module recipe_module_name` command line interface. The first one could also work in `recipes.py run recipe_name --help` too. The generated help text could list all valid input properties, their help strings, the docstring for the recipe itself, etc.
,
Apr 26 2016
,
Jun 3 2016
,
Jun 24 2016
,
Aug 1 2016
Issue 565568 has been merged into this issue.
,
Aug 2 2016
,
Aug 3 2016
,
Aug 10 2016
,
Feb 2 2017
,
May 4 2017
,
May 4 2017
,
May 6 2017
,
May 15 2017
,
Jul 13 2017
fixed?
,
Nov 16 2017
good enough for now |
|||||||||||||
►
Sign in to add a comment |
|||||||||||||
Comment 1 by iannu...@google.com
, Mar 10 2016