Azure / Azure/azure-cli-dev-tools

[linter] should validate help example option place-holders

Open
#29 0 comments 0 reactions 1 assignee Claimed by @mmyyrroonn View on GitHub
enhancement Linter
Dominant language
Python
Stars
91
Forks
134
Avg merge
2h 51m
Merged PRs (30d)
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]

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.