Undocumented Cmd method print_topics
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 35.9k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
Documentation
When exploring the Cmd Python library, I realized that there is no documentation for print_topics method.
I only realized the missing documentation because I noticed that print_topics method has an unused parameter called cmdlen, and I couldn't figure out if it is actually useful for something.
I could also notice that on typeshed it is typed as Any, even though it seems to be only used as an int.
Extra doubts:
Maybe print_topics should be renamed to _print_topics or we should document how to use it properly?
Also, is that cmdlen parameter really needed?
I am willing to contribute with that, but I don't know which type of issue I should open to report an unused param.
Links:
- Cmd documentation: https://docs.python.org/3.13/library/cmd.html
- Cdm.print_topics definition: https://github.com/python/cpython/blob/main/Lib/cmd.py#L346
- typeshed: https://github.com/python/typeshed/blob/main/stdlib/cmd.pyi#L45
Linked PRs
- gh-134539
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla definizione di print_topics in Lib/cmd.py#L346, dalla documentazione di Cmd e dalla relativa dichiarazione typeshed. Esamina la PR collegata gh-134539 e le questioni irrisolte riguardanti cmdlen, la denominazione e la tipizzazione prima di decidere il comportamento pubblico previsto. Il lavoro è completo quando il comportamento concordato e l’uso dei parametri sono documentati e l’annotazione typeshed è stata gestita, se necessario.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100