Skip to content

CLI docs generator: escape more character types #62728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ptgott wants to merge 1 commit into
base: master
Choose a base branch
from
+11 −3
Open

CLI docs generator: escape more character types #62728

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions lib/utils/usage_docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,10 +253,18 @@ func formatUsageArg(arg *kingpin.ArgModel) string {
}

// formatHelp prints help text to include in a Markdown table cell. It escapes
// curly braces to avoid breaking the MDX parser, and it escapes pipes to
// avoid breaking the cell.
// curly, angle, and square braces to avoid breaking the MDX parser, and it
// escapes pipes to avoid breaking the cell.
func formatHelp(help string) string {
return strings.NewReplacer("{", `\{`, "}", `\}`, "|", `\|`).Replace(help)
return strings.NewReplacer(
"{", `\{`,
"}", `\}`,
"|", `\|`,
"[", `\[`,
"]", `\]`,
"<", `\<`,
">", `\>`,
).Replace(help)
}

// docsUsageTemplatePath points to a help text template for CLI reference
Expand Down
Loading