don't insist on @manual.builddict; rm it from many places

Review Request #703 - Created July 18, 2014 and submitted

Information
Larry Hosken
pants
Reviewers
pants-reviews
jsirois
@manual.builddict is mostly redundant now. So clean clean clean.

Change the BUILD-Dictionary-building logic: document registered things; not just those registered things that were tagged @manual.builddict.

This change adds/removes some things from the BUILD dictionary:

Removes:
  __file__
  ROOT_DIR

Adds:
  buildfile_path
  config
  get_buildroot
  get_scm
  pants_version
  set_scm
  zglobs

Added some docstrings.
Changed some lambda to lambda+__doc__

Motivation:

A couple of refactorings ago, we had lots of symbols def'd in BUILD files we didn't want folks to use. "Yeah, you _could_ use JvmTarget for that, but please use java_library instead." We used @manual.builddict to carefully mark those things we wanted to show up in the BUILD Dictionary.

In these enlightened days, we carefully craft our register.py files to specify the symbols we want. Thus, @manual.builddict is mostly a duplication of effort. (It's still useful for methods: most methods shouldn't be used in BUILD files. But a few of them are still around. So, even with this change, we mark those with @manual.builddict)
https://travis-ci.org/pantsbuild/pants/builds/30317126

publish_docs.sh and eyeballing
Larry Hosken
John Sirois
John Sirois
John Sirois
Larry Hosken
Review request changed

Status: Closed (submitted)

Loading...