Context.items/keys/values docstrings claim lists but return iterators
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
_contextvars.Context.items(), .keys(), and .values() return iterator objects, but their docstrings state that they return lists.
Linked PRs
- gh-142919
- gh-143266
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 locating the docstrings for _contextvars.Context.items(), keys(), and values(), then compare their stated return types with the iterator behavior described in the issue. Done means all three docstrings accurately describe returning iterators; linked PRs gh-142919 and gh-143266 indicate that this work may already be underway.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100