Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

man-page is incorrectly formatted by GNU help2man

Offen
  • Stimmt etwas nicht?
#3,119 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

The issue identifies GNU help2man formatting of the generated man page and suggests argparse-manpage as an alternative; it does not name repository files or tests. Start by locating how codespell's man page is generated and compare the current output with the broken examples. Done means the usage, options, and wrapped descriptions appear correctly in the generated man page.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

enhancement packaging

You use GNU help2man to generate man page but it does not understand Python argparse output properly. (This is known issue of GNU help2man.)

Broken formatting examples with explanations:

SYNOPSIS
       codespell [OPTIONS] [file1 file2 ... fileN]

DESCRIPTION
       codespell  is  designed  to  find  and  fix common misspellings in text
       files.  It is designed  primarily  for  checking  misspelled  words  in
       source code, but it can be used with other files as well.

       usage: codespell [-h] [--version] [-d] [-c] [-w] [-D DICTIONARY]

              [--builtin BUILTIN-LIST] [--ignore-regex IGNORE_REGEX] [-I FILE]
              [-L   WORDS]   [--uri-ignore-words-list   WORDS]   [-r    REGEX]
              [--uri-regex  URI_REGEX]  [-s] [--count] [-S SKIP] [-x FILE] [-i
              INTERACTIVE] [-q QUIET_LEVEL] [-e]  [-f]  [-H]  [-A  LINES]  [-B
              LINES] [-C LINES] [--config CONFIG] [--toml TOML] [files ...]

   positional arguments:
       files  files or directories to check
  • usage output should go into SYNOPSIS
  • Empty line is inserted after first and following lines of usage.
  • No OPTIONS section, all options went into DESCRIPTION.
       -i INTERACTIVE, --interactive `INTERACTIVE`
              set interactive mode when writing changes: - 0:  no  interactiv‐
              ity.   -  1:  ask for confirmation.  - 2: ask user to choose one
              fix when more than one is

       available.
              - 3: both 1 and 2
  • available is incorrectly split into next paragraph.

Other converters you may consider using:

Vorherrschende Sprache
Python
Sterne
2.4k
Forks
531
Ø Merge
15 Std. 5 Min.
Gemergte PRs (30 T.)
18

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Keine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

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

Mehr aus codespell-project/codespell

Alle Issues in codespell-project/codespell

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.