The docs show use of docstrings as flow descriptions but I cannot get that working, thoughts?

Hi Eddy, thanks for reporting this, I can't seem to get it to work as intended either with the following:

Sweet

It should be this:

from prefect import flow


@flow(name="My Example Flow")
def my_flow():
    """An example flow for a tutorial."""
    # run tasks and subflows


assert my_flow.description == "An example flow for a tutorial."

We will fix this as soon as possible

Where should this description appear? I cannot see one added with description parameter or docstring anywhere cli or prefect ui

It will appear in your Prefect UI under Deployments

Not sure if I am using this wrong but I cannot see the description appearing

Sorry for the wrong suggestion. To add the description to the deployment, you want to add the description to the

deployment.yaml

files or through the UI

# deployment.yaml
name: hello
description: your description here
tags:
- test
schedule: null
parameters: {}
infrastructure:
  type: process
  env: {}
  labels: {}
  name: null
  command:
  - python
  - -m
  - prefect.engine
  stream_output: true

That's good to know but where are the descriptions added to Flows or Tasks directly (with a

description

parameter or docstring) shown?

Hello there! Wondering if there is any update regarding the description kwarg in

flow()

and the supposed auto docs from flow docstring functionality.

For now, the

description

parameter from a flow is not visible. We recommend that you add the description to a deployment instead of a flow.

Hello everyone, to give this issue more visibility, would you mind opening a github issue here describing what you're seeing?

Update: The description will be visible in the UI with a release to be shipped later this week.

Thank you @Khuyen Tran!