Azure / Azure/azure-cli-dev-tools

[linter] should validate help example option place-holders

Aperta
#29 0 commenti 0 reazioni 1 assegnatario Rivendicata da @mmyyrroonn Vedi su GitHub
enhancement Linter
Lingua principale
Python
Stelle
91
Fork
134
Merge medio
2h 51m
PR unite (30g)
1

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.