Document actual aiohttp defaults for remote timeouts
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
The help strings for different remote timeout fields just says that it uses aiohttp's defaults. Having to find and dig through aiohttp's docs and code was painful and not a very user friendly experience. I imagine some users may not even know what aiohttp even is. However, it seems that aiohttp defines DEFAULT_TIMEOUT that could be used to document the actual defaults:
>>> from aiohttp.client import DEFAULT_TIMEOUT
>>> DEFAULT_TIMEOUT
ClientTimeout(total=300, connect=None, sock_read=None, sock_connect=None)
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 in pulpcore/app/serializers/repository.py around lines 171-206, where the remote timeout help strings refer users to aiohttp's defaults. Check aiohttp.client.DEFAULT_TIMEOUT for the documented values, then update those help strings and verify each remote timeout field states its actual default.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100