Add glossary of terms to click reference docs
Open
Beginner friendly
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 17.7k
- Forks
- 2.3k
- Avg merge
- 1d 30m
- Merged PRs (30d)
- 18
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the general reference documentation in the Click repository and review its existing terminology and structure. Add a glossary section defining Option, flag, command line application, command line utility, and terminal for consistent usage; done means all five terms have clear project-specific definitions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100