Use Case

Currently to populate the description of a @pipeline(), you have to specify the description in decorator keyword arguments.

@pipeline(
   description="Download, process, and transform HYCOM data for a date"
)
def daily_hycom_download():
    date = input_date()
    hycom_ds_for_date(date)

This differs from @solid(), which will use the functions docstring for a description, if a description keyword argument is not specified.

@solid(config_schema={"date": str})
def input_date(context,) -> str:
    """ Return a a YYYY-MM-DD string from the context """

    return context.solid_config["date"]

It would be nice to have the interfaces to the common decorators be similar, and using the docstring for the description, keeps relevant function information where a Python programmer expects to see it, allowing:

@pipeline()
def daily_hycom_download():
    """ Download, process, and transfrom HYCOM data for a date """

    date = input_date()
    hycom_ds_for_date(date)

Ideas of Implementation

It looks like @solid() picks up the docstring if the description is not specified on line 92 of _Solid.__call__()

@pipeline() should similarly be able to be tweaked in _Pipeline.__call__() to get a similar result.

Changing description=self.description of fn.__doc__, should it.

Additional Info

Message from the maintainers:

Excited about this feature? Give it a 👍. We factor engagement into prioritization.