Skip to content

Commit 123a966

Browse files
00xcandreeaflorescu
authored andcommitted
Fix invalid HTML tag warnings in generated docs
Several documentation items were enclosed in angle brackets, which would cause rustdoc to interpret them as HTML tags, generating incorrect documentation. Enclose these in backticks for clarity. While we are at it, fix list formatting for said items. See-also: https://doc.rust-lang.org/rustdoc/lints.html#invalid_html_tags Signed-off-by: Carlos López <carlos.lopez@suse.com>
1 parent 1ccf97b commit 123a966

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/cmdline/mod.rs

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -433,12 +433,14 @@ impl Cmdline {
433433
slug.matches('\"').count() % 2 == 0
434434
}
435435

436-
/// Tries to build a [`Cmdline`] with a given capacity from a str. The format of the
437-
/// str provided must be one of the followings:
438-
/// -> <boot args> -- <init args>
439-
/// -> <boot args>
440-
/// where <boot args> and <init args> can contain '--' only if double quoted and
441-
/// <boot args> and <init args> contain at least one non-whitespace char each.
436+
/// Tries to build a [`Cmdline`] with a given capacity from a [`str`]. The format of the
437+
/// str provided must be one of the following:
438+
///
439+
/// * `<boot args> -- <init args>`
440+
/// * `<boot args>`
441+
///
442+
/// where `<boot args>` and `<init args>` can contain `--` only if double quoted and
443+
/// `<boot args>` and `<init args>` contain at least one non-whitespace char each.
442444
///
443445
/// Providing a str not following these rules might end up in undefined behaviour of
444446
/// the resulting `Cmdline`.

0 commit comments

Comments
 (0)