docs: reformat run module docstrings to Google style for better mkdocstrings rendering #1740
+102
−58
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
…strings rendering On https://openai.github.io/openai-agents-python/ref/run , the docstrings for the run functions were previously in a very raw, unstructured format, making them difficult to read. This PR reformats those docstrings into Google style, so they now render cleanly and are reader-friendly in the documentation site. Changes: Reformatted docstrings for run, run_sync, and run_streaming. Added consistent section headers (Args, Returns, Note). Adjusted indentation, spacing, and blank lines only. Notes:⚠️ No wording or content was changed — only formatting. Purpose: Improve readability and usability of the reference docs without altering semantics.
seratch
requested changes
Sep 15, 2025
|
The changes look good to me; can you resolve the conflicts with the latest main branch? |
seratch
approved these changes
Sep 17, 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.
On https://openai.github.io/openai-agents-python/ref/run, the docstrings for the run functions were previously in a very raw, unstructured format, making them difficult to read.
This PR reformats those docstrings into Google style, so they now render cleanly and are reader-friendly in the documentation site.
Changes:
Reformatted docstrings for run, run_sync, and run_streaming.
Added consistent section headers (Args, Returns, Note).
Adjusted indentation, spacing, and blank lines only.
Notes:
Purpose: Improve readability and usability of the reference docs without altering semantics.