Skip to content

Add glossary of terms to documentation#3210

Open
by22Jy wants to merge 4 commits intopallets:mainfrom
by22Jy:add-glossary
Open

Add glossary of terms to documentation#3210
by22Jy wants to merge 4 commits intopallets:mainfrom
by22Jy:add-glossary

Conversation

@by22Jy
Copy link

@by22Jy by22Jy commented Feb 17, 2026

Summary

Adds a glossary section to Click's documentation defining key terms used throughout the docs.

Changes

  • Added docs/glossary.rst with definitions for 10 key terms
  • Updated docs/index.rst to include the glossary in General Reference section

Terms Defined

  • Argument: Positional parameter passed to a command
  • Callback: Function invoked when a parameter is processed
  • Command: Function decorated with @click.command() or @click.group()
  • Command Line Interface (CLI): Text-based interface for program interaction
  • Context: Object carrying state between commands
  • Flag: Boolean option without a value
  • Group: Command containing subcommands
  • Multi-command: Command grouping multiple subcommands
  • Option: Named parameter with dash prefix
  • Parameter: General term for options and arguments

Closes #3077

Checklist

  • Documentation builds correctly
  • Follows existing documentation style
  • Terms are clear and consistent with Click's usage

by22Jy and others added 3 commits February 17, 2026 16:24
Adds a glossary section defining key terms used throughout Click's documentation.

Terms defined:
- Argument
- Callback
- Command
- Command Line Interface (CLI)
- Context
- Flag
- Group
- Multi-command
- Option
- Parameter

Closes pallets#3077
@nrschroeder
Copy link

This looks good ... the glossary seems like it will make the docs a lot clearer.

One thing I noticed while reading the issue is that it also mentioned terms like “terminal”, “command line application”, and “command line utility”. Since those show up in different places in the docs as well, it might be helpful to include them here too for completeness.

@by22Jy
Copy link
Author

by22Jy commented Mar 15, 2026

Hi @nrschroeder, thank you for the great suggestion! I've added the three additional terms you mentioned:

  • Terminal: A text-based interface for interacting with the operating system
  • Command Line Application: A Python program built with Click that provides a CLI
  • Command Line Utility: A command line application designed to perform specific tasks

These terms will definitely help make the documentation more comprehensive. Let me know if you'd like any adjustments to the definitions!

…y to glossary

Following maintainer feedback to include more commonly used terms.
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