Fix Docstring Reference in 'ToolsToFinalOutputFunction' in 'agent.py' #391
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
rm-openai
approved these changes
Apr 1, 2025
Lightblues
pushed a commit
to Lightblues/openai-agents-python
that referenced
this pull request
Apr 13, 2025
…openai#391) ### **Summary** This pull request fixes docstring in `ToolsToFinalOutputFunction`, where `ToolToFinalOutputResult` was incorrectly referenced instead of `ToolsToFinalOutputResult`. ### **Changes Made** - Updated the docstring of `ToolsToFinalOutputFunction` to correctly reference `ToolsToFinalOutputResult`. ### **Before** ```python """A function that takes a run context and a list of tool results, and returns a `ToolToFinalOutputResult`. """ ``` ### **After** ```python """A function that takes a run context and a list of tool results, and returns a `ToolsToFinalOutputResult`. """ ``` ### **Why This Change?** - The incorrect reference could cause confusion for developers reading the code. - This aligns the documentation with the actual return type of the function. ### **Checklist** - [x] Verify correct reference to `ToolsToFinalOutputResult` - [x] Ensure no functionality is affected ### **Testing** This is a documentation-only change and does not affect runtime behavior. ### **Reviewer Notes** - Please review for accuracy in documentation. - No additional tests are needed since this is a non-functional change.
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
This pull request fixes docstring in
ToolsToFinalOutputFunction, whereToolToFinalOutputResultwas incorrectly referenced instead ofToolsToFinalOutputResult.Changes Made
ToolsToFinalOutputFunctionto correctly referenceToolsToFinalOutputResult.Before
After
Why This Change?
Checklist
ToolsToFinalOutputResultTesting
This is a documentation-only change and does not affect runtime behavior.
Reviewer Notes