man-page is incorrectly formatted by GNU help2man
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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
usageoutput should go into SYNOPSIS- Empty line is inserted after first and following lines of
usage. - No
OPTIONSsection, all options went intoDESCRIPTION.
-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
availableis incorrectly split into next paragraph.
Other converters you may consider using:
- 主要语言
- Python
- 星标
- 2.4k
- 派生
- 531
- 平均合并
- 15 小时 5 分钟
- 30 天内合并 PR
- 18
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
codespell-project/codespell 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
codespell-project/codespell#3997 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 63/100
codespell-project/codespell#3965 · 3 条评论 ·
维护者通常 1 天内回复
-
Add "marcos"可能已有人在做 @ekanshul 于 20 天前认领。 未关闭dictionary
难度 2/5 1-3 小时 新手友好度 72/100
codespell-project/codespell#3920 · 3 条评论 ·
维护者通常 1 天内回复
-
question
难度 3/5 1-2 天 新手友好度 55/100
codespell-project/codespell#4005 ·
维护者通常 1 天内回复
-
duplicate question
难度 2/5 1-3 小时 新手友好度 35/100
codespell-project/codespell#3998 ·
维护者通常 1 天内回复
查看 codespell-project/codespell 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
Graphify-Labs/graphify#4860 · 1 条评论 ·
维护者通常 1 天内回复
-
:bug: Bug
难度 2/5 1-3 小时 新手友好度 84/100
scikit-image/scikit-image#8377 ·
维护者通常 1 天内回复
-
Ingredient import validation accepts negative nutrient values and NaN可能已有人在做 @LukeSekai 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
wger-project/wger#2564 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
apache/ponymail-foal#351 ·
-
难度 1/5 1 小时以内 新手友好度 68/100
维护者通常 4 天内回复