Add the compile.zinc options to the options reference
Review Request #3186 - Created Nov. 29, 2015 and submitted
|benjyw, gmalmquist, jsirois|
- Extracts group task information into options reference
- Sorts the names of the tasks under a goal
Original output: http://pantsbuild.github.io/options_reference.html#compile
New output is here: http://pantsbuild.github.io/staging/zundel/options_reference.html#compile
This is fine, I guess, but I'd rather we just got rid of GroupTask. It's a blight on the codebase, and now completely unnecessary. There are probably several other things subtly broken because of it.
But if you do submit this, since you're in this cognitiva area anyway, can you also figure out why the description of the compile goal is the unhelpful "Check that used dependencies have been requested" and replace that with something reasonable? It should be as simple as replacing a docstring or a description string in register.py. I can't think of anywhere else that text can come from.
remove with_description() from jvm-dep-check registration. This registers a description for the entire goal, not just the subtask.
Revision 2 (+32 -20)
Thanks for that docfix.
I'll file an issue for me to go over all the register.pys and remove the descriptions, so that we fall back to the ones culled from the docstrings (which I will inspect for relevance).