Skip to content

docs: Clarify and enhance run_demo_loop utility documentation for beginners #1330

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

Merged
merged 5 commits into from
Aug 1, 2025

Conversation

UmmeHabiba1312
Copy link
Contributor

This Pull Request aims to improve the clarity and user-friendliness of the run_demo_loop utility documentation. While the existing description is accurate, this update refines it to be more accessible for new users and beginners.

Key improvements in this update:

  • Expanded Description: The introductory text now provides a clearer explanation of run_demo_loop's purpose and its benefit for quick, interactive testing.
  • Enhanced Code Comments: The Python example is now annotated with simple comments that guide the user through each part of the code, explaining what the Agent is and how the loop is started.
  • Structured Explanation: The description of how run_demo_loop works is reorganized into a more readable and easy-to-digest paragraph. It clearly explains key features like prompting for input, maintaining conversation history, and real-time streaming of output.
  • Clear Exit Instructions: The method for exiting the loop is presented in a straightforward manner.

These changes make the documentation more engaging and effective for developers new to the SDK, helping them get started with agents and interactive testing with minimal friction.

I believe this is a valuable documentation improvement that will enhance the overall developer experience.

docs/tracing.md Outdated
@@ -39,7 +39,7 @@ By default, the SDK traces the following:
- Audio outputs (text-to-speech) are wrapped in a `speech_span()`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you revert the changes for this file, this pull request looks good to me.

Copy link
Contributor Author

@UmmeHabiba1312 UmmeHabiba1312 Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reverted the changes to that file. Let me know if anything else needs to be updated.
Thanks again for reviewing!

@seratch seratch added the documentation Improvements or additions to documentation label Jul 31, 2025
@seratch seratch enabled auto-merge (squash) August 1, 2025 11:04
@seratch seratch merged commit a9763dc into openai:main Aug 1, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants