Skip to content

docs: add glossary of terms to general reference#3394

Closed
Giggitycountless wants to merge 1 commit intopallets:mainfrom
Giggitycountless:docs/glossary
Closed

docs: add glossary of terms to general reference#3394
Giggitycountless wants to merge 1 commit intopallets:mainfrom
Giggitycountless:docs/glossary

Conversation

@Giggitycountless
Copy link
Copy Markdown

Description

Add a glossary section to the general reference docs defining key terms as they are used throughout the Click documentation. This helps maintain internal consistency and reduces ambiguity for new users.

Terms defined

  • Application / Command line application — a complete CLI program built with Click
  • Argument — a positional parameter
  • Command — a single callable unit
  • Command line utility — an application for a specific task
  • Flag — a boolean option ()
  • Group — a command containing subcommands
  • Option — a named parameter ()
  • Parameter — generic term for options and arguments
  • Terminal — the text-based interface

Each term uses MyST cross-references (, , , ) to link to detailed documentation.

Fixes #3077

Add a glossary defining key terms (Option, flag, command line
application, command line utility, terminal, etc.) as they are
used throughout the Click documentation. Uses MyST cross-references
to link terms to their detailed documentation pages.

Fixes pallets#3077
@davidism davidism closed this Apr 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add glossary of terms to click reference docs

2 participants