curses: initscr(), newterm(), start_color() and the screen type have no docstrings
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 36k
- Métricas de merge de PRs
- Métricas de PR pendentes
Descrição
Bug report
curses.initscr(), curses.newterm() and curses.start_color() are Python wrappers of the C functions (they copy the ACS_*, LINES/COLS and COLORS/COLOR_PAIRS constants into the package), and the wrappers have no docstring, so help(curses.initscr) shows nothing although _curses.initscr is documented. The curses.screen type has no docstring either, unlike window, complexchar and complexstr.
Also, the docstring of _curses.initscr() says "Return a WindowObject", the name of the C struct rather than the Python type.
Linked PRs
- gh-157547
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pelos pontos de entrada curses.initscr(), curses.newterm(), curses.start_color() e curses.screen, comparando a saída de ajuda deles com os tipos documentados _curses.initscr(), window, complexchar e complexstr. O trabalho estará concluído quando os wrappers e o tipo screen tiverem docstrings úteis e _curses.initscr() nomear corretamente o tipo Python; verifique o trabalho vinculado gh-157547 antes de começar.
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
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 25/100