Open
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. |
Author
|
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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