Python documentation in Texinfo format: Problems with `dircategory` and `direntry` commands
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 36k
- PR 合并指标
- PR 指标待抓取
描述
Documentation
The Python documentation could be downloaded in Texinfo and Info format.
Which is great, I'm very very thankful for it.
But their is multiple problems, in the python.texi file, with the @dircategory and @direntry commands.
The @dircategory is now set to "Miscellaneous". It should be set to a more descriptive category. Like "Programming" or "Programming language" or "Python". A "Python" category could be re-used by other manuals related to Python. For example a manual for a Python framework or library.
In the @direntry command:
- The info file name, in parenthesis, should not include the
.infoextension [1] - The menu entry description should be more descriptive than "One line description of project"
[1] https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Listing-a-New-Info-File
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
打开 python.texi 并检查其中的 @dircategory 和 @direntry 命令,然后将它们当前的值与 issue 中链接的 Texinfo 指南进行比较。当类别具有描述性、Info 文件名省略 .info 扩展名,并且菜单描述标识 Python 文档而不是使用占位文本时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 描述清楚
- 新手友好度
- 35/100