eza-community/eza

bug: Problems with man pages

开放

#981 创建于 2024年5月10日

在 GitHub 查看贡献者指南
 (6 条评论) (1 个反应) (0 位负责人)Rust (439 个派生)batch import
good first issuetype: docs

仓库指标

星标
 (21,783 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

Those are the ones I spotted right away, if there are more, please add in comments.

  1. There is no documentation for --absolute option
  2. Man pages contain $version string, which I think should be replaced with an actual eza version number
  3. in "SEE ALSO" section, man pages still point to markdown files, for example eza_colors.5.md . The .md suffix should be removed in man pages.

贡献者指南

研究方向
首先检查仓库 'man' 目录中的 man page 源文件。找到 '$version' 的使用位置，并确定应如何用 Cargo.toml 中的实际版本替换它。对于缺失的 absolute 选项，在相应的 man page 中添加描述。移除 SEE ALSO 引用中的 '.md' 后缀。检查是否存在生成 man page 的构建脚本。
技术栈
rust
领域
clidocumentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Gitman pages
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90