Misaligned help text with positional arguments and numpydoc
还没有人认领这个 Issue。
评估
调研方向
使用提供的 test.py 示例复现该问题,并运行 python test.py --help。跟踪 Numpydoc 位置参数的 CLI 帮助生成路径,然后验证每个参数是否保留自己的描述,而不是与前一个参数的描述合并。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- Python
- 星标
- 28.2k
- 派生
- 1.5k
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
google/python-fire 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
google/python-fire#693 ·
-
Release 0.7.2? 未关闭
难度 3/5 1-2 天 新手友好度 38/100
google/python-fire#698 ·
-
难度 3/5 1-2 天 新手友好度 58/100
google/python-fire#672 · 5 条评论 ·
-
难度 4/5 3-5 天 新手友好度 45/100
google/python-fire#665 · 2 条评论 ·
-
难度 4/5 3-5 天 新手友好度 55/100
google/python-fire#659 · 1 条评论 ·
查看 google/python-fire 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 90/100
learningequality/ricecooker#747 ·
-
难度 2/5 1-3 小时 新手友好度 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 76/100
run-llama/llama_index#23199 ·
-
难度 2/5 1-3 小时 新手友好度 84/100
KhronosGroup/glTF-Blender-IO#2769 ·