Skip to content
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

Open
3 of 9 tasks
zjs opened this issue Jul 28, 2021 · 0 comments
Open
3 of 9 tasks

Provide a dictionary of definitions for entries in the CLI wordlist #296

zjs opened this issue Jul 28, 2021 · 0 comments
Labels
area/docs enhancement New feature or request good first issue Good for newcomers priority/important-soon retriage Triage, again.
Milestone

Comments

@zjs
Copy link
Member

zjs commented Jul 28, 2021

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)

  • APIs
  • Addons
  • CLI
  • Docs
  • Installation
  • Plugin
  • Security
  • Test and Release
  • User Experience

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.

@iancoffey iancoffey assigned iancoffey and unassigned iancoffey Jul 30, 2021
@iancoffey iancoffey added the good first issue Good for newcomers label Jul 30, 2021
@iancoffey iancoffey self-assigned this Jul 30, 2021
@iancoffey iancoffey added the retriage Triage, again. label Sep 14, 2021
@iancoffey iancoffey removed their assignment Sep 14, 2021
@vuil vuil added this to the v.Next milestone Oct 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs enhancement New feature or request good first issue Good for newcomers priority/important-soon retriage Triage, again.
Projects
None yet
Development

No branches or pull requests

3 participants