chore: align docs with https://github.com/dapr/dapr-agents/pull/283 #4955
+4
−12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Casper Nielsen <casper@diagrid.io>
4 tasks
msfussell
approved these changes
Dec 4, 2025
bibryam
reviewed
Dec 4, 2025
| #### 1. Ad-hoc execution with `runner.run(...)` | ||
|
|
||
| Use `run` when you want to trigger a durable workflow directly from Python code (tests, CLIs, notebooks, etc.). The runner locates the agent's `@workflow_entry`, schedules it, and optionally waits for completion. Call `travel_planner.start()` first so the workflow runtime is registered. | ||
| Use `run` when you want to trigger a durable workflow directly from Python code (tests, CLIs, notebooks, etc.). The runner locates the agent's `@workflow_entry`, schedules it, and optionally waits for completion. |
Contributor
There was a problem hiding this comment.
How is it optional?
Instead of describing the internals about the workflow entry, we should say:
The run command is a blocking call that triggers the agent and waits for it to finish.
Then LGTM
Contributor
Author
There was a problem hiding this comment.
I'll update this. I didn't review the other aspect of the docs, only updated the section regarding no longer needing to call .start() on the agent
Contributor
Author
Signed-off-by: Casper Nielsen <casper@diagrid.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Aligning with dapr/dapr-agents#283 changes
Issue reference
N/A