docs: Clarify the is_enabled parameter in handoff() documentation
#1472
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
vcshih
pushed a commit
to veris-ai/openai-agents-python
that referenced
this pull request
Aug 15, 2025
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.
This pull request aims to improve the clarity and completeness of the
handoff()function documentation.Currently, the
handoff()function documentation lists several parameters but omits theis_enabledparameter, which is present in the underlying source code. This can be confusing for developers trying to dynamically control handoff behavior.This change adds
is_enabledto the list of parameters in the documentation, making it easier for users to understand and utilize this feature.The addition will also align the documentation with the actual implementation, enhancing the overall user experience.