pub struct HelpSection {
pub heading: String,
pub lines: Vec<String>,
pub anchor: Option<String>,
}Expand description
One named block of body lines. Rendered after the doc and before
the source links. Used by impls to surface type-specific structure
(e.g. :describe-command renders an “Arguments:” section from
args_schema).
anchor (DESIGN.md §5.11) lets cross-references jump to the
section. Convention is kind:name – e.g. arg:path,
args (the parent section), section:examples. The anchor
name is recorded against the section’s heading line in the
rendered output so a follower can scroll directly to it.
Fields§
§heading: StringThe section’s heading line, rendered verbatim (e.g. "Arguments:").
lines: Vec<String>Body lines under the heading, rendered verbatim — impls indent them themselves.
anchor: Option<String>Anchor name recorded against the heading line, or None for a
section nothing links to.
Auto Trait Implementations§
impl Freeze for HelpSection
impl RefUnwindSafe for HelpSection
impl Send for HelpSection
impl Sync for HelpSection
impl Unpin for HelpSection
impl UnsafeUnpin for HelpSection
impl UnwindSafe for HelpSection
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more