This repository has been archived by the owner on Oct 10, 2023. It is now read-only.
Provide a dictionary of definitions for entries in the CLI wordlist #296
Labels
area/docs
enhancement
New feature or request
good first issue
Good for newcomers
priority/important-soon
retriage
Triage, again.
Milestone
Describe the feature request
We have a wordlist that's used to lint the nouns and verbs used in by CLI plugins.
It would be useful to have a machine-parseable and human-readable dictionary of definitions for these words. Defining these in one place would provide a single source of reference for developers considering re-using a term (to help avoid unintentionally re-using the same word to mean different things). It would also help de-duplicate definitions of these words; some terms are defined multiple times, in slightly different ways, in help text, documentation, etc.
Describe alternatives you've considered
Perhaps the dictionary could be included as comments in the wordlist. This doesn't allow for re-use though.
Affected product area (please put an X in all that apply)
Additional context
When making this change, we should update the instructions for the wordlist to also recommend updating the dictionary. Perhaps an automatic check should ensure that every element in the wordlist is defined.
The text was updated successfully, but these errors were encountered: