https://prefect.io logo
Join Slack
Powered by
The <docs> show use of docstrings as flow descript...
# data-tricks-and-tips
e
The docs show use of docstrings as flow descriptions but I cannot get that working, thoughts?
👀 2
✅ 1
Copy code
from prefect import flow

@flow(name="My Example Flow")
    """An example flow for a tutorial."""
def my_flow():
    # run tasks and subflows
b
Hi Eddy, thanks for reporting this, I can't seem to get it to work as intended either with the following:
Copy code
from prefect import flow

@flow(name="My Example Flow")
    """An example flow for a tutorial."""
def my_flow():
    print("Hi, this is my flow!")


my_flow()
I'll raise this to the team and see what's going on here.
e
Sweet
k
It should be this:
Copy code
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
e
Where should this description appear? I cannot see one added with description parameter or docstring anywhere cli or prefect ui
k
It will appear in your Prefect UI under Deployments
e
Not sure if I am using this wrong but I cannot see the description appearing
k
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
Copy code
# 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
e
That's good to know but where are the descriptions added to Flows or Tasks directly (with a 
description
parameter or docstring) shown?
c
Hello there! Wondering if there is any update regarding the description kwarg in 
flow()
and the supposed auto docs from flow docstring functionality.
k
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.
b
Hello everyone, to give this issue more visibility, would you mind opening a github issue here describing what you're seeing?
k
Update: The description will be visible in the UI with a release to be shipped later this week.
🎉 1
🦜 2
🙏 1
b
Thank you @Khuyen Tran!
3 Views
Open in Slack
PreviousNext
Powered by