ImageCollection.build return value doesn't match the documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 13d 8h
- Merged PRs (30d)
- 2
Description
ImageCollection.build can return a tuple or an image (or a Model, I don't really know what the difference is but that's what my type checker is saying)
However the documentation only talk about the tuple
See here
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 docker/models/images.py at the documented ImageCollection.build return description linked in the issue. Compare that documentation with the actual return behavior and the type checker’s reported image or Model alternatives. Update the documentation to describe the supported return values accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100