You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/command-line-syntax.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# How we document our command line syntax
2
2
3
-
## Required text
3
+
## Literal text
4
4
5
5
Use plain text for parts of the command that cannot be changed
6
6
@@ -10,23 +10,26 @@ The argument help is required in this command
10
10
11
11
## Placeholder values
12
12
13
-
Use angled brackets to represent a value the user must replace
13
+
Use angled brackets to represent a value the user must replace. No other expressions can be contained within the angeled brackets.
14
14
15
15
_example:_
16
16
`gh pr view <issue-number>`
17
17
Replace `<issue-number>` with an issue number
18
18
19
19
## Optional arguments
20
20
21
-
Place optional arguments in square brackets
21
+
Place optional arguments in square brackets. Mutually exclusive arguments can be included inside square brackets if they are separated with vertical bars.
22
22
23
23
_example:_
24
24
`gh pr checkout [--web]`
25
25
The argument `--web` is optional.
26
26
27
-
## Mutually exclusive arguments
27
+
`gh pr view [<number> | <url>]`
28
+
The `<number>` and `<url>` arguments are optional.
28
29
29
-
Place mutually exclusive arguments inside braces, separate arguments with vertical bars.
30
+
## Required mutually exclusive arguments
31
+
32
+
Place required mutually exclusive arguments inside braces, separate arguments with vertical bars.
0 commit comments