pallets/click

Add glossary of terms to click reference docs

Open

#3,077 建立於 2025年9月21日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)Python (14,710 star) (1,419 fork)batch import
docsgood first issue

描述

Add a section to the general reference docs for glossary of terms. Should contain ambiguous terms that defines how we use them in our docs. It allows us to be internally consistent in our usage

  • Option
  • flag
  • command line application
  • command line utility
  • terminal

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic knowledge of Clickfamiliarity with reStructuredText
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
Review the existing Click documentation structure in the docs/ directory. Identify where to place the glossary (e.g., docs/reference.rst or a new file). Look at the Click contributing guide for style guidelines. Then create a glossary section defining the terms: option, flag, command line application, command line utility, terminal, explaining how Click uses them.