Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

man-page is incorrectly formatted by GNU help2man

Đang mở
  • Có gì không ổn?
#3,119 1 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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:

Ngôn ngữ chính
Python
Star
2.4k
Fork
531
Merge trung bình
15 giờ 55 phút
Pull request đã merge (30 ngày)
17

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Không có Dockerfile hay tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của codespell-project/codespell

Tất cả issue của codespell-project/codespell

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.