pallets/click

Add glossary of terms to click reference docs

Open

#3077 opened on Sep 21, 2025

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (14,710 stars) (1,419 forks)batch import
docsgood first issue

Description

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of Clickfamiliarity with reStructuredText
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.