google / google/python-fire

Misaligned help text with positional arguments and numpydoc

Abierto
#439 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
28.2k
Forks
1.5k
Métricas de merge de PR
Sin PR fusionados en 30 d

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`.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.