Improve documentation on async/await patterns
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 349
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 318
Description
Description
Contributors implementing custom resource servers or agents may encounter async/await errors without clear guidance on best practices. This creates unnecessary friction for those less familiar with async Python patterns.
Context
This feedback came from external contributor experience during environment integration work. https://github.com/NVIDIA-NeMo/Gym/pull/203
Proposed improvements
- Add async/await best practices to docs/tutorials/
- Include common error patterns and fixes (e.g., "Task was destroyed but it is pending")
- Show proper async context management patterns
- Add examples of correct async patterns for multi-turn interactions
- Reference working examples from the codebase
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing material under docs/tutorials/ and the contributor experience described in PR 203. Find working async examples in the codebase, then document common errors, async context management, and multi-turn interaction patterns. Done means the tutorials contain actionable guidance and examples covering the proposed cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100