Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

man-page is incorrectly formatted by GNU help2man

Aperta
  • Qualcosa non va?
#3,119 1 commento 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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:

Lingua principale
Python
Stelle
2.4k
Fork
531
Merge medio
15h 55m
PR unite (30g)
17

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

  • Nessun Dockerfile né file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di codespell-project/codespell

Tutte le issue di codespell-project/codespell

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.