Tweak on guardrail docstrings #1260
Merged
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
1. ✅ Fixed article usage ("a" to "an") before class names starting with vowel sounds
2. ✅ Corrected possessive form ("function name" to "function's name")
3. ✅ Removed redundant word ("do" in "to do check" → "to check")
Corrected multiple documentation issues across the guardrail implementation:
- Fixed article usage ("a" → "an") before class names starting with vowel sounds
- Corrected possessive forms ("function name" → "function's name")
- Removed redundant words ("to do check" → "to check")
- Resolved line length violations (E501) by restructuring long docstring lines
seratch
added
documentation
seratch
approved these changes
Jul 28, 2025
seratch
changed the title
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
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.
✅ The article usage is now grammatically correct with "an" before class names starting with vowel sounds
✅ The possessive form correctly uses "function's name" instead of "function name"
✅ The redundant word "do" has been removed from "to do check" → "to check"
✅ The line length violations (E501) have been resolved with proper docstring formatting
✅ Overall documentation now maintains professional consistency and grammatical accuracy