Improve the frozenset.is(sub|super)set docstrings
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
RE: Documentation provided by built-in function help()
While reviewing built-in methods in detail I made note of:
- "help(frozenset)" issubset and issuperset methods both return bool type
Other comments that were not issues
See https://github.com/python/cpython/issues/129622#issuecomment-2633394435.
- "help(slice)" third parameter typo
- "help(range)" third parameter typo
- "help(float)" quizzical hex method example
- "help(bool)" is bit_length method also for absolute value of self?
- "help(bool)" is_integer appears duck-like compatible with int (TypeError with float)
- "help(bool)" from_bytes appears to return a bool from byte array
Regards,
'EntryLevelJobSeeker'
Linked PRs
- gh-129637
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 running help(frozenset) and reviewing the issubset and issuperset docstrings in the CPython source. Compare their wording with the methods' bool return behavior; the documentation is done when both docstrings accurately describe that result. Linked PR gh-129637 indicates that work is already underway.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100