Azure / Azure/azure-cli-dev-tools

[linter] should validate help example option place-holders

Abierto
#29 0 comentarios 0 reacciones 1 asignado Reclamado por @mmyyrroonn Ver en GitHub
enhancement Linter
Lenguaje dominante
Python
Estrellas
91
Forks
134
Merge medio
2 h 51 min
PR fusionados (30 d)
1

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.