Python SDK examples README overstates async.py coverage

Open Beginner friendly
#25,543 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start with sdk/python/examples/README.md and compare its stated sync.py/async.py coverage and run instructions with sdk/python/examples/09_async_parity/. Update the documentation or add the missing example so the folder-specific behavior is accurate, then verify the README no longer instructs users to run a nonexistent file.

Written by the indexing model from the issue text.

Description

documentation
What happened?

sdk/python/examples/README.md says:

Each example folder contains runnable versions:
- sync.py
- async.py

However, sdk/python/examples/09_async_parity/ currently contains sync.py but no async.py. The generic run instructions also tell users to run python examples/<example-folder>/async.py, which does not work for that folder.

Expected behavior

Either every example folder should contain both sync.py and async.py, or the examples README should call out exceptions such as 09_async_parity.

Additional context

I searched open issues and PRs for 09_async_parity, the README wording, and Python SDK examples, and did not find an existing open item that appears to cover this examples-doc mismatch.

Dominant language
Rust
Stars
125k
Forks
19.5k
Avg merge
1m
Merged PRs (30d)
1k

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openai/codex

All issues in openai/codex

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.