From 3ebf229ac4e3fcacc1a15908aef1488ab608f60f Mon Sep 17 00:00:00 2001 From: Kevin Su Date: Fri, 25 Aug 2023 03:01:31 -0700 Subject: [PATCH] Add screenshots of Flyte UI in the docstring workflow page (#1049) * Add screenshots of Flyte UI in the docstring workflow page Signed-off-by: Kevin Su * update link Signed-off-by: Kevin Su * lint Signed-off-by: Kevin Su --------- Signed-off-by: Kevin Su --- examples/basics/basics/documented_workflow.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/examples/basics/basics/documented_workflow.py b/examples/basics/basics/documented_workflow.py index ef70c345f..cebe1d998 100644 --- a/examples/basics/basics/documented_workflow.py +++ b/examples/basics/basics/documented_workflow.py @@ -64,6 +64,19 @@ def sphinx_docstring(df: pd.DataFrame, data: PandasData = PandasData()) -> pd.Da return add_data(df=df, data=data) +# %% [markdown] +# You'll see the short description in the workflow page. +# :::{figure} https://github.com/flyteorg/static-resources/blob/main/flyte/concepts/basics/short_description.png +# :alt: short description +# :class: with-shadow +# ::: +# +# If you click the workflow, you'll see the long description in the basic information section. +# :::{figure} https://github.com/flyteorg/static-resources/blob/main/flyte/concepts/basics/long_description.png +# :alt: short description +# :class: with-shadow +# ::: + # %% [markdown] # ## NumPy-style Docstring #