python / python/cpython

curses: initscr(), newterm(), start_color() and the screen type have no docstrings

Abierto
#157,546 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs topic-curses type-bug
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con los puntos de entrada curses.initscr(), curses.newterm(), curses.start_color() y curses.screen, comparando su salida de ayuda con los tipos documentados _curses.initscr(), window, complexchar y complexstr. Se considera terminado cuando los wrappers y el tipo screen tengan docstrings útiles y _curses.initscr() nombre correctamente el tipo de Python; revisa el trabajo enlazado gh-157547 antes de empezar.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.