python / python/cpython

Undocumented Cmd method print_topics

Ouverte
#128,430 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

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:
Linked PRs
  • gh-134539

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la définition de print_topics dans Lib/cmd.py#L346, la documentation de Cmd et sa déclaration typeshed. Examinez la PR liée gh-134539 ainsi que les questions non résolues concernant cmdlen, le nommage et le typage avant de décider du comportement public attendu. Le travail est terminé lorsque le comportement convenu et l’utilisation des paramètres sont documentés, et que l’annotation typeshed a été traitée si nécessaire.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.