Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

man-page is incorrectly formatted by GNU help2man

Abierto
  • ¿Algo no está bien?
#3,119 1 comentario 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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:

Lenguaje dominante
Python
Estrellas
2.4k
Forks
531
Merge medio
15 h 55 min
PR fusionados (30 d)
17

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

  • Sin Dockerfile ni archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de codespell-project/codespell

Todos los issues de codespell-project/codespell

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.