Cleanups to the tasks developer's guide #docfixit

Review Request #2594 - Created Aug. 11, 2015 and submitted

Information
Stu Hood
pants
13106eb...
Reviewers
pants-reviews
benjyw, kwlzn, lahosken
  • Use simpler include examples (was previously including register.py from the JVM backend, which is pretty hairy)
  • Expand the Product section and place it before the require_data section, in order to explain what products are before talking about how they influence ordering
  • Add a section describing option options.
  • Add some links to other portions of the docs that better explain concepts.

inspection of:

build-support/bin/publish_docs.sh -o

https://github.com/pantsbuild/pants/pull/1949

Issues

  • 0
  • 2
  • 0
  • 2
Description From Last Updated
Stu Hood
Larry Hosken
Stu Hood
Stu Hood
Review request changed

Status: Closed (submitted)

Benjy Weinberger

   
src/python/pants/docs/dev_tasks.md (Diff revision 2)
 
 

"Option Options" isn't terminology we use, so maybe best not to make it a thing here?

  1. Will drop.

src/python/pants/docs/dev_tasks.md (Diff revision 2)
 
 

Probably a good idea to describe action=, metavar= and advanced=?

Also maybe an example or two?

Maybe mention that these are a subset of argparse options?

  1. Will include action/advanced.

    sub/super ? argparse seems more like an implementation detail.

    I figure there are lots of examples in the codebase once people know what they're looking at. And a good representative sample is included immediately above.

Stu Hood

Followup review over here: https://rbcommons.com/s/twitter/r/2612/

Loading...