STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Avoid using <...> in docs

Browse source 
When converted to HTML docs, these get interpreted as HTML tags.

In theory, we could encapsulate these bits in backticks, but the docs are
already in raw Go string literals, and we can't easily escape backticks in that
context. Instead, just avoid using `<>` for now.
This commit is contained in:
Mislav Marohnić 2020-01-23 10:28:29 +01:00
parent 305410cdee
commit f5ad43458c
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
command/issue.go
View file

@ -47,7 +47,7 @@ var issueCmd = &cobra.Command{
An issue can be supplied as argument in any of the following formats:
- by number, e.g. "123"; or
- by URL, e.g. "https://github.com/<owner>/<repo>/issues/123".`,
- by URL, e.g. "https://github.com/OWNER/REPO/issues/123".`,
}
var issueCreateCmd = &cobra.Command{
Use: "create",

4
command/pr.go
View file

@ -42,8 +42,8 @@ var prCmd = &cobra.Command{
A pull request can be supplied as argument in any of the following formats:
- by number, e.g. "123";
- by URL, e.g. "https://github.com/<owner>/<repo>/pull/123"; or
- by the name of its head branch, e.g. "patch-1" or "<owner>:patch-1".`,
- by URL, e.g. "https://github.com/OWNER/REPO/pull/123"; or
- by the name of its head branch, e.g. "patch-1" or "OWNER:patch-1".`,
}
var prCheckoutCmd = &cobra.Command{
Use: "checkout {<number> | <url> | <branch>}",