Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Misaligned help text with positional arguments and numpydoc

Abierto
#439 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
cli

Línea de trabajo

Reproduce el problema con el ejemplo proporcionado de test.py y ejecuta python test.py --help. Sigue la ruta de generación de la ayuda de la CLI para los argumentos posicionales de Numpydoc y verifica después que cada argumento conserve su propia descripción en lugar de fusionarse con la anterior.

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

Descripción

When using Numpydoc docstring style with multiple positional arguments the help text gets misaligned

import fire

def run(executable, argument):
    """Run.

    Parameters
    ----------
    executable :
            Executable to run
    argument :
            Positional argument to the executable

    """
    print("hello")

if __name__ == "__main__":
    fire.Fire(run)

When run with python test.py --help this code produces

INFO: Showing help with the command 'test.py -- --help'.

NAME
    test.py - Run.

SYNOPSIS
    test.py EXECUTABLE ARGUMENT

DESCRIPTION
    Run.

POSITIONAL ARGUMENTS
    EXECUTABLE
        Executable to run

        Positional argument to the executable
    ARGUMENT

NOTES
    You can also use flags syntax for POSITIONAL ARGUMENTS

where the help text to argument gets added to executable.

Lenguaje dominante
Python
Estrellas
28.2k
Forks
1.5k
Sin PR fusionados en 30 d

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.

Más de google/python-fire

Todos los issues de google/python-fire

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.