Azure / Azure/azure-cli-dev-tools
[linter] should validate help example option place-holders
Offen
enhancement
Linter
- Vorherrschende Sprache
- Python
- Sterne
- 91
- Forks
- 134
- Ø Merge
- 2 Std. 51 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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]
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Bewertung
Dieses Issue wurde noch nicht bewertet.