Azure / Azure/azure-cli-dev-tools

[linter] should validate help example option place-holders

オープン
#29 コメント 0 件 リアクション 0 件 担当者 1 名 @mmyyrroonn が担当を希望しています GitHub で見る
enhancement Linter
主要言語
Python
スター
91
フォーク
134
平均マージ
2時間 51分
マージ済み PR(30日)
1

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。