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 摘要。