google / google/python-fire

Misaligned help text with positional arguments and numpydoc

Ouverte
#439 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
28.2k
Forks
1.5k
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.