eza-community/eza

bug: Problems with man pages

Open

#981 opened on May 10, 2024

View on GitHub
 (6 comments) (1 reaction) (0 assignees)Rust (21,783 stars) (439 forks)batch import
errorsgood first issue

Description

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.

Contributor guide

Tech stack
rustshell
Domain
documentationcli
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Start by examining the man page source files in the repository's 'man' directory. Locate where '$version' is used and determine how it should be replaced with the actual version from Cargo.toml. For the missing absolute option, add a description in the appropriate man page. Remove '.md' suffixes from SEE ALSO references. Check if there are any build scripts that generate man pages.