tldr-pages/tldr

Add mnemonics to commands that only have short options available

Aperta

#16.218 aperta il 21 apr 2025

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Markdown (5381 fork)batch import
help wanted

Metriche repository

Star
 (63.468 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

There are quite a lot of commands that do not provide long options and are thus a black box to new users. Mnemonics should help with that. A trick to finding pages that contain a short option is grep -r " -[a-zA-Z][^a-zA-Z]" This does not however find pages that have two short options groupled together like -ab

Mnemonics style guide: https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#short-option-mnemonics

Also: If you manage to find a case where the short option isn't derived from the long option, for example {{[-n|--dry-run]}}, add a mnemonic for that.

Guida contributor

Direzione di ricerca
Trova le pagine tldr che hanno solo opzioni brevi (ad esempio v) ma mancano di mnemonici. Usa grep r " [a zA Z][^a zA Z]" per identificare i candidati, poi controlla la sintassi di ogni pagina per la mancanza di mnemonici per opzioni brevi. Aggiungi mnemonici seguendo la guida di stile su https://github.com/tldr pages/tldr/blob/main/contributing guides/style guide.md#short option mnemonics. Cerca anche i casi in cui l'opzione breve non deriva da quella lunga (ad esempio n vs dry run) e aggiungi mnemonici lì.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Gitcommand line basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85