Improve the frozenset.is(sub|super)set docstrings
Offen
Dieses Issue hat noch niemand übernommen.
docs
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Ausführung von help(frozenset) und überprüfe die Docstrings von issubset und issuperset im CPython-Quellcode. Vergleiche ihre Formulierung mit dem bool-Rückgabeverhalten der Methoden; die Dokumentation ist abgeschlossen, wenn beide Docstrings dieses Ergebnis korrekt beschreiben. Der verknüpfte PR gh-129637 zeigt, dass diese Arbeit bereits im Gange ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100