Document behavior of treq's pool
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 603
- Forks
- 140
- PR merge metrics
- No merged PRs in 30d
Description
Currently using treq in tests leads to reactor unclean errors which unnecessarily confuses people (#86).
Maybe also add a convenience method to close it to spare people this dance.
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 with the issue description and the linked section of treq/test/test_treq_integration.py, then inspect how treq's pool behaves during tests and shutdown. Document the behavior that causes reactor unclean errors, and determine whether the optional convenience method belongs in the same work. Done means the lifecycle and cleanup expectations are clear to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100