Deprecate calling with_description() when registering a task.

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

Information
Benjy Weinberger
pants
Reviewers
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

Matt Olsen
Nick Howard (Twitter)
Eric Ayers
Benjy Weinberger
Benjy Weinberger
Review request changed

Status: Closed (submitted)

Change Summary:

857f6353a1157de643e8b84d9db0a9d17811a71c

Loading...