python / python/cpython

Undocumented Cmd method print_topics

Aberta
#128,430 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs
Linguagem predominante
Python
Estrelas
77.2k
Forks
36k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pela definição de print_topics em Lib/cmd.py#L346, pela documentação de Cmd e por sua declaração no typeshed. Revise o PR vinculado gh-134539 e as questões não resolvidas sobre cmdlen, nomenclatura e tipagem antes de decidir o comportamento público pretendido. Considera-se concluído quando o comportamento acordado e o uso dos parâmetros estiverem documentados, e a anotação do typeshed tiver sido tratada, se necessário.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.