tldr-pages/tldr

Add mnemonics to commands that only have short options available

Open

#16,218 建立於 2025年4月21日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Shell (2,507 fork)batch import
help wanted

倉庫指標

Star
 (30,937 star)
PR 合併指標
 (平均合併 7天 5小時) (30 天內合併 321 個 PR)

描述

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.

貢獻者指南

研究方向
查找僅有短選項（例如 v）但缺少助記符的 tldr 頁面。使用 grep r " [a zA Z][^a zA Z]" 找出候選頁面，然後檢查每個頁面的語法是否缺少短選項助記符。按照 https://github.com/tldr pages/tldr/blob/main/contributing guides/style guide.md#short option mnemonics 的樣式指南添加助記符。同時注意查找短選項不從長選項派生的情况（例如 n 與 dry run），並在那裡添加助記符。
技術棧
無
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
大致清晰
前置要求
Gitcommand line basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85