eza-community/eza

bug: Problems with man pages

Offen

#981 geöffnet am 10.05.2024

Auf GitHub ansehenContributor Guide
 (6 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Rust (439 Forks)batch import
good first issuetype: docs

Repository-Metriken

Stars
 (21.783 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Beginnen Sie mit der Untersuchung der Manpage Quelldateien im 'man' Verzeichnis des Repositorys. Finden Sie heraus, wo '$version' verwendet wird, und bestimmen Sie, wie es durch die tatsächliche Version aus Cargo.toml ersetzt werden soll. Fügen Sie für die fehlende absolute Option eine Beschreibung in der entsprechenden Manpage hinzu. Entfernen Sie die '.md' Suffixe aus den SEE ALSO Referenzen. Prüfen Sie, ob es Build Skripte gibt, die Manpages generieren.
Tech Stack
rust
Domain
clidocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Gitman pages
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90