Skip to content

Commit

Permalink
Fix non-portable doc comments warning
Browse files Browse the repository at this point in the history
A line starting with > might be interpreted as a block quote.
In regular markdown this could be prevented by escaping the `>`
using a backslash. However, since the doc comments are used by
clap for the long help more or less verbatim, the `\` would be visible
hence the shuffling around of words.
  • Loading branch information
bash committed Sep 6, 2024
1 parent 2d1cb20 commit 8bce7ac
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -411,9 +411,9 @@ pub struct Opt {
/// and line numbers link to the local file using a file URL, whereas commit hashes link to the
/// commit in GitHub, if the remote repository is hosted by GitHub. See
/// --hyperlinks-file-link-format for full control over the file URLs emitted. Hyperlinks are
/// supported by several common terminal emulators. To make them work, you must use less version
/// >= 581 with the -R flag (or use -r with older less versions, but this will break e.g.
/// --navigate). If you use tmux, then you will also need a patched fork of tmux (see
/// supported by several common terminal emulators. To make them work, you must use less
/// version >= 581 with the -R flag (or use -r with older less versions, but this will break
/// e.g. --navigate). If you use tmux, then you will also need a patched fork of tmux (see
/// <https://github.com/dandavison/tmux>).
pub hyperlinks: bool,

Expand Down

0 comments on commit 8bce7ac

Please sign in to comment.