---
type: email
from: Muhammad Suhaib <notifications@github.com>
subject: [openai/openai-agents-python] docs: reformat run module docstrings to

 Google style for better mkdocstrings rendering (PR #1740)
received: 2026-03-06 07:34:38
date_header: Mon, 15 Sep 2025 03:14:09 -0700
priority: normal
status: awaiting_approval
uid: 30423
---

## Email Content

**From:** Muhammad Suhaib <notifications@github.com>
**Subject:** [openai/openai-agents-python] docs: reformat run module docstrings to

 Google style for better mkdocstrings rendering (PR #1740)
**Date:** Mon, 15 Sep 2025 03:14:09 -0700

### Body (preview)

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.



&lt;img width=&quot;1890&quot; height=&quot;1106&quot; alt=&quot;comparison&quot; src=&quot;https://github.com/user-attachments/assets/e62bf9f0-143e-4950-b9b4-a9d6b49ff71c&quot; /&gt;



You can view, comment on, or merge this pull request online at:



  https://github.com/openai/openai-agents-python/pull/1740



-- Commit Summary --



  * docs: reformat run module docstrings to Google style for better mkdocstrings rendering



-- File Changes --



    M src/agents/run.py (276)



-- Patch Links --



https://github.com/openai/openai-agents-python/pull/1740.patch

https://github.com/openai/openai-agents-python/pull/1740.diff



-- 

Reply to this email directly or view it on GitHub:

https://github.com/openai/openai-agents-python/pull/1740

You are receiving this because you are subscribed to this thread.



Message ID: &lt;openai/openai-agents-python/pull/1740@github.com&gt;

---

## Suggested Actions
- [ ] Reply
- [ ] Archive
- [ ] Escalate
