diff options
| author | Evan Read <eread@gitlab.com> | 2023-07-12 03:21:56 +0300 |
|---|---|---|
| committer | Justin Tobler <jtobler@gitlab.com> | 2023-07-12 03:21:56 +0300 |
| commit | bc8e52ebef931f4d47afff658b89800f2957411a (patch) | |
| tree | a2f34424570d6009c529ef127a9b88891a0768e3 /doc | |
| parent | db86f94f1921fb1affa96adaffb45b78de569129 (diff) | |
Go back and update Gitaly CLI for new style guide updates
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/help_text_style_guide.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/help_text_style_guide.md b/doc/help_text_style_guide.md index f7e028961..b11654f4d 100644 --- a/doc/help_text_style_guide.md +++ b/doc/help_text_style_guide.md @@ -93,8 +93,17 @@ When providing values for the `Description` field key: Runs all of the processes for the Gitaly Cluster. ``` +If the command or subcommand requires more than just flags, add an example of invoking the command. For example: + +```go +Description: "The subcommand accepts a file on stdin.\n\n" + + + "Example: `command subcommand < file`." + +``` + ## Related topics - [Voice and tone](https://design.gitlab.com/content/voice-and-tone) from GitLab Design System. - [Language](https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language) from GitLab Documentation Style Guide. +- [Command Line Interface Guidelines](https://clig.dev). |