eza-community/eza

bug: Problems with man pages

Ouverte

#981 ouverte le 10 mai 2024

Voir sur GitHubGuide contributeur
 (6 commentaires) (1 réaction) (0 personne assignée)Rust (439 forks)batch import
good first issuetype: docs

Métriques du dépôt

Stars
 (21 783 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Commencez par examiner les fichiers source des pages de manuel dans le répertoire 'man' du dépôt. Repérez où '$version' est utilisé et déterminez comment il doit être remplacé par la version réelle de Cargo.toml. Pour l'option manquante absolute, ajoutez une description dans la page de manuel appropriée. Supprimez les suffixes '.md' des références SEE ALSO. Vérifiez s'il existe des scripts de construction qui génèrent les pages de manuel.
Stack technique
rust
Domaine
clidocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Gitman pages
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90