doc: fix egregious markup output

We use '+++' syntax to output a literal '**' for a '--glob' example.
This '+++' syntax is pretty ugly when rendered literally via --help. We
fix this by hackily inserting the '+++' syntax for its one specific case
that we need it during man page generation.

Not ideal but it works. And --help still has some '*foo*' markup, but we
live with that for now.

Fixes #1581
This commit is contained in:
Andrew Gallant
2020-05-13 08:13:05 -04:00
parent 1e9a481a66
commit 1980630f17
3 changed files with 15 additions and 1 deletions

View File

@@ -1354,7 +1354,7 @@ command line takes precedence.
When this flag is set, every file and directory is applied to it to test for
a match. So for example, if you only want to search in a particular directory
'foo', then *-g foo* is incorrect because 'foo/bar' does not match the glob
'foo'. Instead, you should use *-g +++'foo/**'+++*.
'foo'. Instead, you should use *-g 'foo/**'*.
"
);
let arg = RGArg::flag("glob", "GLOB")