New issue
Advanced search Search tips
Note: Color blocks (like or ) mean that a user may not be available. Tooltip shows the reason.

Issue 593545 link

Starred by 2 users

Issue metadata

Status: Fixed
Owner:
Last visit > 30 days ago
Closed: Nov 2017
Cc:
Components:
EstimatedDays: 10
NextAction: ----
OS: ----
Pri: 2
Type: Bug

Blocked on:
issue 687831

Blocking:
issue 567425



Sign in to add a comment

Make automated documentation in recipes better

Project Member Reported by iannu...@google.com, Mar 10 2016

Issue description

We 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.
 

Comment 1 by iannu...@google.com, Mar 10 2016

Can also show default values and the type for properties. We should also extend this to documenting the retval schema of the recipe.

Comment 2 by aga...@chromium.org, Apr 26 2016

Components: Infra>Platform>Recipes
Labels: -Infra-Recipes
Project Member

Comment 3 by sheriffbot@chromium.org, Jun 3 2016

Labels: Hotlist-Google
Labels: Pri-2
 Issue 565568  has been merged into this issue.
Blocking: 567425
Labels: Type-Bug
Status: Available (was: Untriaged)
Blockedon: 687831

Comment 10 by efoo@chromium.org, May 4 2017

Labels: LUCI-M0-Backlog REQBY-LUCI-M3-ClosedBeta

Comment 11 by efoo@chromium.org, May 4 2017

EstimatedDays: 10

Comment 12 by efoo@chromium.org, May 6 2017

Labels: -LUCI-M0-Backlog -REQBY-LUCI-M3-ClosedBeta
Owner: iannucci@chromium.org
Status: Assigned (was: Available)

Comment 14 by no...@chromium.org, Jul 13 2017

fixed?
Status: Fixed (was: Assigned)
good enough for now

Sign in to add a comment