Deprecate calling with_description() when registering a task.

Review Request #3207 — Created Dec. 3, 2015 and submitted

benjyw
pants
pants-reviews
jsirois, stuhood, zundel

The problem is that this description was associated with the
*goal* the task was registered on, not the task itself.

This meant that we were dependent on registration order. More
problematically, it meant that, e.g., the JVM backend was
creating descriptions for generic goals such as compile and test.

Instead, we introduce an explicit Goal.register(name, description)
solely for providing descriptions for generic, multiple-task goals.

Then we enumerate the generic goals in core_tasks/register.py.

Single-task goals take their description from the task's docstring,
so this change also ensures that we have appropriate docstrings
everywhere.

CI passes: https://travis-ci.org/pantsbuild/pants/builds/94713238

MO
  1. Very nice change. This makes the register.py files much clearer to read IMO.

  2. 
      
NH
  1. This is great. Much less confusing.

  2. 
      
ZU
  1. Ship It!
  2. 
      
BE
  1. Thanks all! Submitted as 857f6353a1157de643e8b84d9db0a9d17811a71c.

  2. 
      
BE
Review request changed

Status: Closed (submitted)

Change Summary:

857f6353a1157de643e8b84d9db0a9d17811a71c

Loading...