Enum NumPyDocstringItem 

pub enum NumPyDocstringItem {
    Section(NumPySection),
    StrayLine(TextRange),
}

A single item in the body of a NumPy-style docstring (after the summary and optional extended summary).

Preserving both sections and stray lines in a single ordered Vec ensures the original source order is never lost, which matters for linters that want to report diagnostics in document order.

Variants

Section(NumPySection)

A recognised (or unknown-name) section with header + underline + body.

StrayLine(TextRange)

A non-blank line that appeared between sections but was neither blank nor recognised as a section header (i.e. not followed by an underline).

Typical causes include misplaced prose, a section name whose underline was accidentally omitted, or text that belongs to a previous section.

Trait Implementations

impl Clone for NumPyDocstringItem

fn clone(&self) -> NumPyDocstringItem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NumPyDocstringItem

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

Formats the value using the given formatter.

impl PartialEq for NumPyDocstringItem

fn eq(&self, other: &NumPyDocstringItem) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NumPyDocstringItem