Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Misaligned help text with positional arguments and numpydoc

未关闭
#439 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
cli

调研方向

使用提供的 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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

google/python-fire 的其他 Issue

查看 google/python-fire 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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