[engine] Split engine docs from example docs

Review Request #3734 — Created April 20, 2016 and submitted

stuhood
pants
3240
pants-reviews
benjyw, gmalmquist, jsirois, patricklaw, wisechengyi

Split engine-specific docs out, added a few concrete example task declarations, and moved topics specific to the examples into the examples subdirectory.

Rendered here:
https://github.com/twitter/pants/tree/stuhood/engine-expand-and-split-docs/src/python/pants/engine/exp#the-new-engine

https://travis-ci.org/pantsbuild/pants/builds/124567602

  1. 
      
  2. src/python/pants/engine/exp/README.md (Diff revision 1)
     
     
    Neither the exclamation points nor the qualifiers add much here. They are out of character with the rest of the doc - I'd cut them out.
  3. src/python/pants/engine/exp/README.md (Diff revision 1)
     
     
    s/subgrapoh/subgraph/
  4. It would be good to note the historical status of this document and point to src/python/pants/engine/exp/README.md as the current source of truth. Lots of what it contains is obsolete, including issues at the bottom marked wont-fix due to the new concept of a front end being introduced.

  5. Kill trailing ws.
  6. 
      
  1. 
      
  2. this needs to be fixed.

    1. nm, didn't read carefully, tests/...examples/ is good.

  3. Hitory can Design Goals probably should still be in exp/README.md.

  4. 
      
  1. Ship It!
  2. 
      
Review request changed

Status: Closed (submitted)

Change Summary:

Merged as ce047f004950d57e11113019abe61e2070befe93

Loading...