eza-community/eza

bug: Problems with man pages

オープン

#981 opened on 2024/05/10

GitHub で見るコントリビューターガイド
 (6 件のコメント) (1 件のリアクション) (0 人の担当者)Rust (439 件のフォーク)batch import
good first issuetype: docs

Repository metrics

Stars
 (21,783 個のスター)
PR merge metrics
 (30d に merged 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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Gitman pages
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90