Skip to content

Commit 67f65a0

Browse files
committed
Update doc
1 parent cb8d996 commit 67f65a0

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/command-line-syntax.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# How we document our command line syntax
22

3-
## Required arguments
3+
## Required text
44

5-
Use plain text
5+
Use plain text for any part of the command that can not be changed
66

77
_*example:*_
88
`gh help`
@@ -36,11 +36,19 @@ _*example:*_
3636
Ellipsis represent arguments that can appear multiple times
3737

3838
_*example:*_
39-
`gh pr close <numbers … >`
39+
`gh pr close <numbers>...`
4040

4141
## Variable naming
4242

4343
For multi-word variables use dash-case (all lower case with words seperated by dashes)
4444

4545
_*example:*_
4646
`gh pr checkout <issue-number>`
47+
48+
## Complex examples
49+
50+
_*required argument with mutually exclusive optoins:*_
51+
`gh pr close <{number | url}>`
52+
53+
_*optional argument with mutually exclusive optoins:*_
54+
`gh pr close [{<number> | <url>}]`

0 commit comments

Comments
 (0)