ipython / ipython/traitlets

Generate manpage from configuration options

Abierto
#636 1 comentario 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
653
Forks
217
Merge medio
2 d 21 h
PR fusionados (30 d)
2

Descripción

In https://github.com/jupyter/jupyter_server/issues/320, @SnarkBoojum submitted a manpage for Jupyter Server that largely encoded the results from `--help`. We realized that it would make more sense to have an automatically generated manpage at the traitlet level from the configurable traits. This issue is about adding a `--generate-manpage` option, or perhaps a separate manpage generation command, that does something similar to `-h`, but generates the output as a manpage.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Start by tracing how configurable traits produce the existing `-h` output and how a command-line option or separate command would fit at the traitlet level. Define whether `--generate-manpage` or a separate command is the intended interface, then verify that the generated output captures the configurable options in manpage form.

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

Evaluación

Stack tecnológico
python
Área
cli
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.