Remove "unconditionally" from conditional description #1289
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
The current docstrings regarding tool creation read, "unconditionally creates a structured tool (return type annotation permitting)". If the return type annotation limits whether or not a structured tool can be created, then creation of a structured tool is *conditional* upon the presence of a proper return type annotation. Therefore, these descriptions should not include the word "unconditionally", as it is inaccurate and contradictory.
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.
The current docstrings regarding tool creation read, "unconditionally creates a structured tool (return type annotation permitting)". If the return type annotation limits whether or not a structured tool can be created, then creation of a structured tool is conditional upon the presence of a proper return type annotation. Therefore, these descriptions should not include the word "unconditionally", as it is inaccurate and contradictory.
Motivation and Context
Certain docstrings are self-contradictory, which is either a mistake or an indication that the description is not sufficiently clear.
How Has This Been Tested?
Since this changes only docstrings, it has not been tested.
Breaking Changes
None
Types of changes
Checklist