docs: document auto_previous_response_id#3383
Merged
Merged
Conversation
seratch
requested changes
May 13, 2026
Member
seratch
left a comment
There was a problem hiding this comment.
We'd like to have only the auto_previous_response_id documentation
…s value list PR openai#2117 added the `auto_previous_response_id` parameter to `Runner.run`, `Runner.run_sync`, and `Runner.run_streamed` signatures but did not document it in the `Args:` blocks (parameter appears in `inspect.signature` but not in `inspect.getdoc`). Add the missing `auto_previous_response_id` entry to each `Args:` block. Drop the "Currently supports max_turns" enumeration from the `error_handlers` docstrings (3 in `run.py`, 1 in `run_config.py:RunOptions.error_handlers`) to avoid documenting a list that will drift again as more handler kinds are added.
79d5b26 to
b9c37e8
Compare
Contributor
Author
|
Thanks for the review! Updated to address both comments:
Rebased onto latest |
seratch
approved these changes
May 13, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Two pieces of doc drift accumulated in the public `Runner` methods:
This PR adds the missing `auto_previous_response_id` entry to each `Args:` block and updates the `error_handlers` description to list both handler kinds.
Test plan
```
$ uv run python -c "
import inspect
from agents import Runner
for name in ('run', 'run_sync', 'run_streamed'):
doc = inspect.getdoc(getattr(Runner, name)) or ''
print(name, 'auto_previous_response_id:', 'auto_previous_response_id' in doc,
'model_refusal:', 'model_refusal' in doc)
"
run auto_previous_response_id: True model_refusal: True
run_sync auto_previous_response_id: True model_refusal: True
run_streamed auto_previous_response_id: True model_refusal: True
```
Issue number
N/A — found during a docstring/signature drift audit following recent param/handler additions.
Checks