google / google/python-fire

Misaligned help text with positional arguments and numpydoc

未关闭
#439 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
28.2k
派生
1.5k
PR 合并指标
30 天内没有已合并 PR

描述

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

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。