docs: return type actually `bytes` but documented as `str`
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 13d 8h
- Merged PRs (30d)
- 2
Description
For at least one method and possibly others, the return type is actually a binary bytes object, but is documented as str. This might have been correct for 2.7 but it's outright confusing in a python3 world.
I see this being the case for the .logs() container methods, but the type confusion seems to originate at a very low level.
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 .logs() container methods and trace the low-level source of their documented return types in this Python Docker library. Check which affected methods return binary bytes objects in Python 3, then update the documentation so each return type is accurate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100