File tree Expand file tree Collapse file tree 1 file changed +11
-3
lines changed
Expand file tree Collapse file tree 1 file changed +11
-3
lines changed Original file line number Diff line number Diff line change 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:*_
3636Ellipsis 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
4343For 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>}] `
You can’t perform that action at this time.
0 commit comments