python / python/cpython

Improve the frozenset.is(sub|super)set docstrings

Aperta
#129,622 10 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia eseguendo help(frozenset) e rivedendo le docstring di issubset e issuperset nel codice sorgente di CPython. Confronta la loro formulazione con il comportamento di restituzione bool dei metodi; la documentazione sarà completata quando entrambe le docstring descriveranno accuratamente tale risultato. La PR collegata gh-129637 indica che questo lavoro è già in corso.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.