Skip to content

Update OrchestratorWorkflow tool docstring #456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2025
Merged

Update OrchestratorWorkflow tool docstring #456

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions examples/temporal/orchestrator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,12 @@


@app.async_tool(name="OrchestratorWorkflow")
async def run_orchestrator(input: str, app_ctx: Optional[AppContext]) -> str:
async def run_orchestrator(input: str, app_ctx: Optional[AppContext] = None) -> str:
"""
Run the workflow, processing the input data.
Args:
input: Task description or instruction text.
app_ctx: Optional application context for the workflow.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docstring line describing the app_ctx parameter is being removed, but the parameter still exists in the function signature. This creates inconsistent documentation where the function has an app_ctx parameter but no documentation for it. The docstring should be updated to describe the app_ctx parameter with its new default value behavior, not removed entirely.

Suggested change
:param app_ctx: Application context (defaults to None)

Spotted by Diamond

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.

Returns:
A WorkflowResult containing the processed data
Expand Down
Loading