pallets/click

Add glossary of terms to click reference docs

Open

#3,077 opened on 2025年9月21日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Python (14,710 stars) (1,419 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.