Displaying summary of docstring by --list

[hirokiky]

Now, the invoke --list only display names of tasks.
I suggent to display what each tasks do too.

I know the full docstring can be shown invoke --help [task_name].
My suggestion is displaying it's summary (first line of it) when calling invoke --list.

If I wrote the task like this:

@task
def task_a():
    """ Task for show 'a'.

    This command is to test invoke command line tool.
    """
    print('a')

The fixed invoke --list will be like this::

$ invoke --list
Available tasks

task_a: Task for show 'a'.

[bitprophet]

Yup, definitely want this in Invoke, it's currently one of the few things Fabric 1 does that Invoke doesn't yet do, e.g.:

» fab -l

Fabric's own fabfile.

Available commands:

    release      Tag, push tag to Github, & upload new version to PyPI.
    test         Run all unit tests and doctests.
    upload       Build, register and upload to PyPI
    docs         Generate the Sphinx documentation.
    docs.browse  Open the current dev docs in a browser tab.
    docs.build   Generate the Sphinx documentation.
    tag          Tag a new release.
    tag.tag      Tag a new release.

Should be easy enough to port it over :)

[hirokiky]

This issue has been solved.