-
Notifications
You must be signed in to change notification settings - Fork 2k
Fix spelling, grammar, and minor formatting issues in running agents documentation #1128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…documentation **Problem**: The documentation for agent execution contains several minor but distracting issues: - Incorrect pluralization ("OpenAI Responses API" → "OpenAI Response API") - Verb tense mismatch ("outputs produces" → "outputs produced") - Optional inconsistencies in code examples (haiku punctuation, undefined `thread_id`) **Changes**: 1. **Grammar/Spelling Fixes** - Changed `"OpenAI Responses API"` → `"OpenAI Response API"` (singular "Response" aligns with the singular API concept) - Changed `"outputs produces"` → `"outputs produced"` (corrected past-tense verb agreement) 2. **Optional Code Improvements** - Removed period from haiku example for stylistic consistency ```python # Infinite loop's dance. → # Infinite loop's dance ``` - Added explicit `thread_id` definition in manual conversation example ```python thread_id = "thread_123" # Example thread ID ``` **Benefits**: - Improves readability and professionalism of documentation. - Fixes technical inaccuracies in API references and grammar. - Ensures code examples are self-contained and executable without undefined variables. - Maintains stylistic consistency with project standards. All changes preserve the original technical accuracy and intent of the documentation while addressing surface-level issues that could confuse readers or disrupt workflow.
docs/running_agents.md
Outdated
``` | ||
|
||
Read more in the [results guide](results.md). | ||
|
||
## The agent loop | ||
|
||
When you use the run method in `Runner`, you pass in a starting agent and input. The input can either be a string (which is considered a user message), or a list of input items, which are the items in the OpenAI Responses API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Responses API is the correct name; please revert this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I’ve reverted the terminology back to “OpenAI Responses API” throughout the section.
Please let me know if there’s anything else that needs adjustment.
This update cleans up minor issues in the `running_agents.md` documentation: - **Grammar Fix:** Corrects “outputs produces” → “outputs produced” for proper past-tense agreement. - **Code Example Improvements:** - Removes the trailing period from the haiku comment (`# Infinite loop's dance.` → `# Infinite loop's dance`). - Defines `thread_id` explicitly (`thread_id = "thread_123"`) so the manual conversation snippet is self-contained and runnable. These changes enhance readability and ensure all examples are clear and immediately executable without altering any core technical content.
Waiting for the experts review here from @seratch and @rm-openai 🎓 |
Problem:
The documentation for agent execution contains several minor but distracting issues:
thread_id
)Changes:
"outputs produces"
→"outputs produced"
(corrected past-tense verb agreement)python # Infinite loop's dance. → # Infinite loop's dance
thread_id
definition in manual conversation examplepython thread_id = "thread_123" # Example thread ID