Struct Document 

pub struct Document<'a> { /* private fields */ }

Style-independent view of a parsed docstring root.

Construct with Document::new from any Parsed result, whatever the source style.

Implementations

impl<'a> Document<'a>

pub fn new(parsed: &'a Parsed) -> Self

View the root of parsed as a style-independent document.

Examples found in repository

examples/parse_numpy.rs (line 39)

fn main() {
    let docstring = r#"
Calculate the area of a rectangle.

This function takes the width and height of a rectangle
and returns its area.

Parameters
----------
width : float
    The width of the rectangle.
height : float
    The height of the rectangle.

Returns
-------
float
    The area of the rectangle.

Raises
------
ValueError
    If width or height is negative.

Examples
--------
>>> calculate_area(5.0, 3.0)
15.0
"#;

    let parsed = parse_numpy(docstring);
    let doc = Document::new(&parsed);

    println!("╔══════════════════════════════════════════════════╗");
    println!("║          NumPy-style Docstring Example           ║");
    println!("╚══════════════════════════════════════════════════╝");

    println!();

    // Display: raw source text
    println!("── raw text ────────────────────────────────────────");
    println!("{}", doc.syntax().range().source_text(parsed.source()));

    println!();

    // pretty_print: structured AST
    println!("── parsed AST ──────────────────────────────────────");
    print!("{}", parsed.pretty_print());
}

pub fn style(&self) -> Style

The style the docstring was parsed as.

pub fn syntax(&self) -> &'a SyntaxNode

Access the underlying SyntaxNode.

Examples found in repository

examples/parse_numpy.rs (line 49)

fn main() {
    let docstring = r#"
Calculate the area of a rectangle.

This function takes the width and height of a rectangle
and returns its area.

Parameters
----------
width : float
    The width of the rectangle.
height : float
    The height of the rectangle.

Returns
-------
float
    The area of the rectangle.

Raises
------
ValueError
    If width or height is negative.

Examples
--------
>>> calculate_area(5.0, 3.0)
15.0
"#;

    let parsed = parse_numpy(docstring);
    let doc = Document::new(&parsed);

    println!("╔══════════════════════════════════════════════════╗");
    println!("║          NumPy-style Docstring Example           ║");
    println!("╚══════════════════════════════════════════════════╝");

    println!();

    // Display: raw source text
    println!("── raw text ────────────────────────────────────────");
    println!("{}", doc.syntax().range().source_text(parsed.source()));

    println!();

    // pretty_print: structured AST
    println!("── parsed AST ──────────────────────────────────────");
    print!("{}", parsed.pretty_print());
}

pub fn summary(&self) -> Option<TextBlock<'a>>

Brief summary block, if present.

pub fn extended_summary(&self) -> Option<TextBlock<'a>>

Extended summary block, if present.

pub fn directives(&self) -> impl Iterator<Item = Directive<'a>>

Iterate over document-level directives (e.g. .. deprecated:: 1.0).

pub fn sections(&self) -> impl Iterator<Item = Section<'a>>

Iterate over all sections, in source order.

pub fn paragraphs(&self) -> impl Iterator<Item = TextBlock<'a>>

Iterate over stray-prose paragraph blocks (PARAGRAPH nodes) between sections, in source order.

Trait Implementations

impl<'a> Clone for Document<'a>

fn clone(&self) -> Document<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Document<'a>

impl<'a> Debug for Document<'a>

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

Formats the value using the given formatter.