eza-community/eza

bug: Problems with man pages

Aperta

#981 aperta il 10 mag 2024

Vedi su GitHubGuida contributor
 (6 commenti) (1 reazione) (0 assegnatari)Rust (439 fork)batch import
good first issuetype: docs

Metriche repository

Star
 (21.783 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Inizia esaminando i file sorgente delle pagine di manuale nella directory 'man' del repository. Individua dove viene utilizzato '$version' e determina come dovrebbe essere sostituito con la versione effettiva da Cargo.toml. Per l'opzione mancante absolute, aggiungi una descrizione nella pagina di manuale appropriata. Rimuovi i suffissi '.md' dai riferimenti SEE ALSO. Verifica se esistono script di build che generano le pagine di manuale.
Tech stack
rust
Dominio
clidocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Gitman pages
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90