pallets/click

Add glossary of terms to click reference docs

Open

#3,077 opened on Sep 21, 2025

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

Repository metrics

Stars
 (14,710 stars)
PR merge metrics
 (Avg merge 3d 11h) (13 merged PRs in 30d)

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

Research direction
Review the existing Click documentation to identify terms like 'option', 'flag', 'command line application', etc., and create a new glossary section with clear definitions.
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.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90