Skip to main content

ManContent

Struct ManContent 

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

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§

Source§

impl ManContent

Source

pub const fn empty() -> Self

Trait Implementations§

Source§

impl Debug for ManContent

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.