Tweak .result() doc #706
Merged
Tweak .result() doc #706
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
cretz
approved these changes
Dec 16, 2024
Comment on lines
+1234
to
+1658
| 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
dandavison
force-pushed
the
result-docstring
branch
from
a1bfa38 to
e7b74dd
Compare
dandavison
force-pushed
the
result-docstring
branch
from
e7b74dd to
3b83d37
Compare
dandavison
force-pushed
the
result-docstring
branch
from
3b83d37 to
b0516fa
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
No description provided.