Azure / Azure/azure-cli-dev-tools
[linter] should validate help example option place-holders
Ouverte
@mmyyrroonn y travaille déjà.
Depuis le 26/3/2020.
enhancement
Linter
- Langage dominant
- Python
- Étoiles
- 91
- Forks
- 134
- Merge moyen
- 2 h 51 min
- PR mergées (30 j)
- 1
Description
After #8083 is merged, work should be done to validate help example parameter placeholders. Parameter placeholders should be surrounded by curly braces and have CamelCase text. The first character can be a capital letter.
Placeholders like:
- <some value>
- [some-value]
Should be replaced with:
- {SomeValue}
Note that values / Placeholders like:
- somevalue
- "somevalue"
- {SomeValue} (only this must be camel-case)
- $somevar
- @some_file.txt
- $(echo foo)
Also update authoring docs with guidelines on authoring command examples.
cc/ @sptramer
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Évaluation
Cette issue n'a pas encore été évaluée.