Misaligned help text with positional arguments and numpydoc
まだ誰も着手していません。
評価
調査の方向性
提供された 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
-
Add: hunch オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
DiamondLightSource/dodal#2211 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
openml/openml-python#1749 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
sipyourdrink-ltd/bernstein#6191 ·