Skip to content

Commit 0c579d1

Browse files
docs(router): enhance create_workflow docstring for clarity
- Updated the docstring for the `create_workflow` function to provide clearer instructions on how to structure the workflow description. The new guidance emphasizes starting with the end goal followed by a set of sequential instructions.
1 parent 4725024 commit 0c579d1

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/askui/chat/api/workflows/router.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ def create_workflow(
4646
workflow_service: WorkflowService = WorkflowServiceDep,
4747
) -> Workflow:
4848
"""
49-
Create a new workflow.
49+
Create a new workflow. The description should start off with the end goal and then
50+
to achieve that goal have a set of clear instructions to be executed in order e.g.
51+
\n1.) open a new tab in the browser \n2.) navigate to a specific URL.
5052
5153
Args:
5254
askui_workspace: The workspace ID from header

0 commit comments

Comments
 (0)