openai-agents-python/docs
Kazuhiro Sera 25f97f979b
Fix typos and misspellings (#486)
Detected typos using typos-cli (https://crates.io/crates/typos-cli). It
detected "occured" in a string constant "handoff_occured" too, but I
didn't change the part this time because it could be a minor breaking
change.


Full outputs:
```
% typos .
error: `Supresses` should be `Suppresses`
  --> ./src/agents/function_schema.py:134:7
    |
134 |     # Supresses warnings about missing annotations for params
    |       ^^^^^^^^^
    |
error: `typ` should be `typo`, `type`
  --> ./src/agents/strict_schema.py:51:5
   |
51 |     typ = json_schema.get("type")
   |     ^^^
   |
error: `typ` should be `typo`, `type`
  --> ./src/agents/strict_schema.py:52:8
   |
52 |     if typ == "object" and "additionalProperties" not in json_schema:
   |        ^^^
   |
error: `typ` should be `typo`, `type`
  --> ./src/agents/strict_schema.py:55:9
   |
55 |         typ == "object"
   |         ^^^
   |
error: `occured` should be `occurred`
  --> ./src/agents/stream_events.py:34:18
   |
34 |         "handoff_occured",
   |                  ^^^^^^^
   |
error: `occured` should be `occurred`
  --> ./src/agents/_run_impl.py:723:69
    |
723 |                 event = RunItemStreamEvent(item=item, name="handoff_occured")
    |                                                                     ^^^^^^^
    |
error: `desitnation` should be `destination`
  --> ./src/agents/tracing/span_data.py:171:25
    |
171 |     Includes source and desitnation agents.
    |                         ^^^^^^^^^^^
    |
error: `exmaples` should be `examples`
  --> ./docs/scripts/translate_docs.py:71:145
   |
71 |         "* The term 'examples' must be code examples when the page mentions the code examples in the repo, it can be translated as either 'code exmaples' or 'sample code'.",
   |                                                                                                                                                 ^^^^^^^^
   |
error: `structed` should be `structured`
  --> ./tests/test_agent_hooks.py:227:16
    |
227 | async def test_structed_output_non_streamed_agent_hooks():
    |                ^^^^^^^^
    |
error: `structed` should be `structured`
  --> ./tests/test_agent_hooks.py:298:16
    |
298 | async def test_structed_output_streamed_agent_hooks():
    |                ^^^^^^^^
    |
```
2025-04-14 10:37:13 -04:00
..
assets Tracing screenshot for MCP docs (#355) 2025-03-26 10:56:34 -07:00
ja Add model_settings guide to models document page (#484) 2025-04-11 13:27:01 -04:00
ref [4/n] Add docs for MCP 2025-03-25 13:25:50 -04:00
scripts Fix typos and misspellings (#486) 2025-04-14 10:37:13 -04:00
stylesheets Initial commit 2025-03-11 09:42:28 -07:00
voice Update quickstart.md 2025-03-23 17:56:55 -04:00
agents.md Improve translation pipeline details (#475) 2025-04-10 16:54:05 -04:00
config.md Improve translation pipeline details (#475) 2025-04-10 16:54:05 -04:00
context.md fix annotation numbering in context management 2025-03-21 21:10:30 +00:00
examples.md add links and mcp + voice examples (#438) 2025-04-04 19:53:12 -04:00
guardrails.md fix line in guardrails 2025-03-21 15:58:34 -04:00
handoffs.md Initial commit 2025-03-11 09:42:28 -07:00
index.md fix: hyphenated compound adjective real world -> real-world for clarity 2025-03-12 10:48:29 +05:45
mcp.md Tracing screenshot for MCP docs (#355) 2025-03-26 10:56:34 -07:00
models.md Add model_settings guide to models document page (#484) 2025-04-11 13:27:01 -04:00
multi_agent.md docs: clarify multi-agent orchestration description 2025-03-11 23:57:03 +01:00
quickstart.md Improve translation pipeline details (#475) 2025-04-10 16:54:05 -04:00
results.md docs: Fix typos in documentation files 2025-03-12 00:12:31 +01:00
running_agents.md Fix reference to group id as session id (#430) 2025-04-03 15:36:35 -04:00
streaming.md Initial commit 2025-03-11 09:42:28 -07:00
tools.md Initial commit 2025-03-11 09:42:28 -07:00
tracing.md Update tracing.md - Added Okahu-Monocle (#385) 2025-04-01 11:57:43 -04:00
visualization.md Update visualization.md 2025-03-25 13:34:45 -04:00