[help] Fix code spans in man pages

This commit is contained in:
Mislav Marohnić 2019-06-26 12:38:26 +02:00
Родитель ebe399f337
Коммит 894d2c5f6b
9 изменённых файлов: 30 добавлений и 29 удалений

Просмотреть файл

@ -18,7 +18,7 @@ var cmdAlias = &Command{
## Options
-s
Output shell script suitable for 'eval'.
Output shell script suitable for ''eval''.
<SHELL>
Specify the type of shell (default: "$SHELL" environment variable).

Просмотреть файл

@ -23,15 +23,15 @@ var cmdApi = &Command{
## Options:
-X, --method <METHOD>
The HTTP method to use for the request (default: "GET"). The method is
automatically set to "POST" if '--field', '--raw-field', or '--input' are
used.
automatically set to "POST" if ''--field'', ''--raw-field'', or ''--input''
are used.
Use '-XGET' to force serializing fields into the query string for the GET
Use ''-XGET'' to force serializing fields into the query string for the GET
request instead of JSON body of the POST request.
-F, --field <KEY>=<VALUE>
Data to serialize with the request. <VALUE> has some magic handling; use
'--raw-field' for sending arbitrary string values.
''--raw-field'' for sending arbitrary string values.
If <VALUE> starts with "@", the rest of the value is interpreted as a
filename to read the value from. Use "@-" to read from standard input.
@ -41,15 +41,15 @@ var cmdApi = &Command{
It is not possible to serialize <VALUE> as a nested JSON array or hash.
Instead, construct the request payload externally and pass it via
'--input'.
''--input''.
Unless '-XGET' was used, all fields are sent serialized as JSON within the
request body. When <ENDPOINT> is "graphql", all fields other than "query"
are grouped under "variables". See
Unless ''-XGET'' was used, all fields are sent serialized as JSON within
the request body. When <ENDPOINT> is "graphql", all fields other than
"query" are grouped under "variables". See
<https://graphql.org/learn/queries/#variables>
-f, --raw-field <KEY>=<VALUE>
Same as '--field', except that it allows values starting with "@", literal
Same as ''--field'', except that it allows values starting with "@", literal
strings "true", "false", and "null", as well as strings that look like
numbers.
@ -69,28 +69,28 @@ var cmdApi = &Command{
--paginate
Automatically request and output the next page of results until all
resources have been listed. For GET requests, this follows the '<next>'
resources have been listed. For GET requests, this follows the ''<next\>''
resource as indicated in the "Link" response header. For GraphQL queries,
this utilizes 'pageInfo' that must be present in the query; see EXAMPLES.
this utilizes ''pageInfo'' that must be present in the query; see EXAMPLES.
Note that multiple JSON documents will be output as a result.
--color[=<WHEN>]
Enable colored output even if stdout is not a terminal. <WHEN> can be one
of "always" (default for '--color'), "never", or "auto" (default).
of "always" (default for ''--color''), "never", or "auto" (default).
--cache <TTL>
Cache valid responses to GET requests for <TTL> seconds.
When using "graphql" as <ENDPOINT>, caching will apply to responses to POST
requests as well. Just make sure to not use '--cache' for any GraphQL
requests as well. Just make sure to not use ''--cache'' for any GraphQL
mutations.
<ENDPOINT>
The GitHub API endpoint to send the HTTP request to (default: "/").
To learn about available endpoints, see <https://developer.github.com/v3/>.
To make GraphQL queries, use "graphql" as <ENDPOINT> and pass '-F query=QUERY'.
To make GraphQL queries, use "graphql" as <ENDPOINT> and pass ''-F query=QUERY''.
If the literal strings "{owner}" or "{repo}" appear in <ENDPOINT> or in the
GraphQL "query" field, fill in those placeholders with values read from the
@ -105,13 +105,13 @@ var cmdApi = &Command{
$ hub api --flat users/octocat/repos
# post a comment to issue #23 of the current repository
$ hub api repos/{owner}/{repo}/issues/23/comments --raw-field "body=Nice job!"
$ hub api repos/{owner}/{repo}/issues/23/comments --raw-field 'body=Nice job!'
# perform a GraphQL query read from a file
$ hub api graphql -F query=@path/to/myquery.graphql
# perform pagination with GraphQL
$ hub api --paginate graphql -f query=''
$ hub api --paginate graphql -f query='
query($endCursor: String) {
repositoryOwner(login: "USER") {
repositories(first: 100, after: $endCursor) {
@ -124,7 +124,8 @@ var cmdApi = &Command{
}
}
}
}''
}
'
## See also:

Просмотреть файл

@ -21,7 +21,7 @@ var cmdCiStatus = &Command{
Print detailed report of all status checks and their URLs.
-f, --format <FORMAT>
Pretty print all status checks using <FORMAT> (implies '--verbose'). See the
Pretty print all status checks using <FORMAT> (implies ''--verbose''). See the
"PRETTY FORMATS" section of git-log(1) for some additional details on how
placeholders are used in format. The available placeholders for issues are:
@ -35,7 +35,7 @@ var cmdCiStatus = &Command{
--color[=<WHEN>]
Enable colored output even if stdout is not a terminal. <WHEN> can be one
of "always" (default for '--color'), "never", or "auto" (default).
of "always" (default for ''--color''), "never", or "auto" (default).
<COMMIT>
A commit SHA or branch name (default: "HEAD").

Просмотреть файл

@ -27,7 +27,7 @@ var cmdClone = &Command{
## Protocol used for cloning
The 'git:' protocol will be used for cloning public repositories, while the SSH
The ''git:'' protocol will be used for cloning public repositories, while the SSH
protocol will be used for private repositories and those that you have push
access to. Alternatively, hub can be configured to use HTTPS protocol for
everything. See "HTTPS instead of git protocol" and "HUB_PROTOCOL" of hub(1).

Просмотреть файл

@ -32,7 +32,7 @@ compare [-uc] [-b <BASE>]
Branch names, tag names, or commit SHAs specifying the range to compare.
<END> defaults to the current branch name.
If a range with two dots ('A..B') is given, it will be transformed into a
If a range with two dots (''A..B'') is given, it will be transformed into a
range with three dots.
## Examples:

Просмотреть файл

@ -31,13 +31,13 @@ help hub-<COMMAND> [--plain-text]
## Lookup mechanism:
On systems that have 'man', help pages are looked up in these directories
On systems that have ''man'', help pages are looked up in these directories
relative to the hub install prefix:
* man/<command>.1
* share/man/man1/<command>.1
On systems without 'man', help pages are looked up using the ".txt" extension.
On systems without ''man'', help pages are looked up using the ".txt" extension.
## See also:

Просмотреть файл

@ -113,8 +113,8 @@ pull-request -i <ISSUE>
## Configuration:
* 'HUB_RETRY_TIMEOUT':
The maximum time to keep retrying after HTTP 422 on '--push' (default: 9).
* ''HUB_RETRY_TIMEOUT'':
The maximum time to keep retrying after HTTP 422 on ''--push'' (default: 9).
## See also:

Просмотреть файл

@ -21,8 +21,8 @@ remote set-url [-p] [<OPTIONS>] <NAME> <USER>[/<REPOSITORY>]
## Options:
-p
(Deprecated) Use the 'ssh:' protocol instead of 'git:' for the remote URL.
The writeable 'ssh:' protocol is automatically used for own repos, GitHub
(Deprecated) Use the ''ssh:'' protocol instead of ''git:'' for the remote URL.
The writeable ''ssh:'' protocol is automatically used for own repos, GitHub
Enterprise remotes, and private or pushable repositories.
<USER>[/<REPOSITORY>]

Просмотреть файл

@ -26,7 +26,7 @@ same-named branch on the remote, treat that as its upstream branch.
## Options:
--color[=<WHEN>]
Enable colored output even if stdout is not a terminal. <WHEN> can be one
of "always" (default for '--color'), "never", or "auto" (default).
of "always" (default for ''--color''), "never", or "auto" (default).
## See also: