Add glossary of terms to documentation#3210
Conversation
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
|
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. |
|
Hi @nrschroeder, thank you for the great suggestion! I've added the three additional terms you mentioned:
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.
AndreasBackx
left a comment
There was a problem hiding this comment.
Would love to primarily get some input from others here. I think this is great to have however, thank you!
|
|
||
| Multi-command | ||
| A command that groups multiple subcommands together. Groups and | ||
| multi-commands are similar concepts in Click. |
There was a problem hiding this comment.
| Multi-command | |
| A command that groups multiple subcommands together. Groups and | |
| multi-commands are similar concepts in Click. | |
| Multi-command | |
| Alias for Group, used to have a slightly different implementation. | |
| Planned for removal in 9.0. |
| via the ``@click.pass_context`` decorator. | ||
|
|
||
| Flag | ||
| A boolean option that doesn't take a value (e.g., ``--verbose`` or ``-v``). |
There was a problem hiding this comment.
I'm not too familiar with how glossaries work in Sphinx. But will "option" here link to the glossary for that word down below automatically or does that need to be done explicitly here and elsewhere in the code? I hope it's the latter.
| Command Line Application | ||
| A Python program built with Click that provides a command line interface. | ||
| Command line applications use commands, options, and arguments to interact | ||
| with users through the terminal. | ||
|
|
||
| Command Line Interface (CLI) | ||
| A text-based interface for interacting with a program through commands, | ||
| options, and arguments. Click helps you build CLIs in Python. |
There was a problem hiding this comment.
Correct me if I'm wrong here. But I feel like "CLI" is common nomenclature for the application, regardless of what the true acronym stands for.
| Command Line Application | |
| A Python program built with Click that provides a command line interface. | |
| Command line applications use commands, options, and arguments to interact | |
| with users through the terminal. | |
| Command Line Interface (CLI) | |
| A text-based interface for interacting with a program through commands, | |
| options, and arguments. Click helps you build CLIs in Python. | |
| Command-line Application | |
| Application meant to be interacted with using a command-line interface. | |
| Often referred to as a CLI as well, even though it's not the true acronym. | |
| Command-line Interface (CLI) | |
| A text-based interface for interacting with a program through commands, | |
| options, and arguments. While CLI is its acronym, a CLI often refers to | |
| an application written for the command-line interface. |
| Command Line Utility | ||
| A command line application designed to perform a specific task or set of | ||
| tasks. Command line utilities are often used for system administration, | ||
| file manipulation, or development workflows. | ||
|
|
There was a problem hiding this comment.
| Command Line Utility | |
| A command line application designed to perform a specific task or set of | |
| tasks. Command line utilities are often used for system administration, | |
| file manipulation, or development workflows. |
Personally I'd remove this to avoid confusion.
|
Unfortunately gen AI, which we don't accept |
Summary
Adds a glossary section to Click's documentation defining key terms used throughout the docs.
Changes
docs/glossary.rstwith definitions for 10 key termsdocs/index.rstto include the glossary in General Reference sectionTerms Defined
@click.command()or@click.group()Closes #3077
Checklist