Skip to content

Tweak .result() doc #706

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 4, 2025
Merged

Tweak .result() doc #706

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
5 changes: 3 additions & 2 deletions temporalio/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1653,8 +1653,9 @@ async def result(

Args:
follow_runs: If true (default), workflow runs will be continually
fetched, until the most recent one is found. If false, the first
result is used.
fetched, until the most recent one is found. If false, return
the result from the first run targeted by the request if that run
ends in a result, otherwise raise an exception.
Comment on lines +1656 to +1658
Copy link
Member

@cretz cretz Dec 16, 2024

Choose a reason for hiding this comment

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

Suggested change
fetched, until the most recent one is found. If false, return
the result from the first run targeted by the request if that run
ends in a result, otherwise raise an exception.
fetched, until the most recent one is found. If false, return
the result or raise an exception for the single run targeted
by the request without traversing into other runs.

Not necessarily better, just "otherwise raise an exception" isn't really clear that this is because in other cases an exception may causes run traversal. But don't have to change.

Copy link
Contributor Author

@dandavison dandavison Sep 4, 2025

Choose a reason for hiding this comment

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

I've read that several times and I haven't acquired any additional understanding. Feel free to create a follow-on PR with an improved wording.

rpc_metadata: Headers used on the RPC call. Keys here override
client-level RPC metadata keys.
rpc_timeout: Optional RPC deadline to set for each RPC call. Note,
Expand Down
Loading