Misaligned help text with positional arguments and numpydoc

Offen

#439 erstellt am 24.2.2023 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 45/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: cli

Rechercherichtung

Reproduziere das Problem mit dem bereitgestellten Beispiel test.py und führe python test.py --help aus. Verfolge den Pfad zur Generierung der CLI-Hilfe für positionale Numpydoc-Argumente und überprüfe anschließend, dass jedes Argument seine eigene Beschreibung behält, anstatt mit der vorhergehenden zusammengeführt zu werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache: Python
Sterne: 28.2k
Forks: 1.5k
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus google/python-fire

Test suite fails on Windows: unescaped path regex in testArgPassing, NamedTemporaryFile reopen in testFileNameFire Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100

google/python-fire#693 · Erstellt am 16.8.2026
Release 0.7.2? Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 38/100

google/python-fire#698 · Erstellt am 30.8.2026
Uncaught exception when a component has a property whose getter raises (intended?) Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 58/100

google/python-fire#672 · 5 Kommentare · Erstellt am 06.6.2026
python-fire: (1) PAGER+shell=True RCE in console_io.More (2) bash $(...) runs when sourcing --completion from maliciously named .py file. PoC verified. Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

google/python-fire#665 · 2 Kommentare · Erstellt am 05.5.2026
**kwargs unexpectedly parses flags for later chained method Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 55/100

google/python-fire#659 · 1 Kommentar · Erstellt am 03.4.2026

Alle Issues in google/python-fire