Struct ManContent 

pub struct ManContent {
    pub description: Option<&'static str>,
    pub extra_sections: &'static [(&'static str, &'static str)],
}

Hand-authored extras for a single command’s documentation.

Returned by extras_for keyed on the subcommand name (or "" for the top-level git-lfs page). Both fields are markdown; xtask renders them to either groff or markdown depending on output format.

Fields

description: Option<&'static str>

Replaces the auto-generated DESCRIPTION (which is just the short about from the clap derive). Markdown.

extra_sections: &'static [(&'static str, &'static str)]

Sections appended after OPTIONS, in order. Each entry is (title, markdown body). Conventional titles: EXAMPLES, FILES, ENVIRONMENT, NOTES, BUGS, SEE ALSO. The title becomes a .SH in groff and a top-level ## in markdown.

Implementations

impl ManContent

pub const fn empty() -> Self

A ManContent with no description and no extra sections.

Returned by extras_for for subcommands that don’t have hand-authored extras; the caller splices in the empty result unconditionally.

Trait Implementations

impl Debug for ManContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.