pydocstring 0.1.10

//! Example: Auto-detecting docstring style with `parse()`
//!
//! Demonstrates the unified `parse()` entry point, which detects the style
//! automatically and returns a `Parsed` result whose root `SyntaxKind`
//! reflects the detected style:
//!
//! - `GOOGLE_DOCSTRING` — Google style (section headers ending with `:`)
//! - `NUMPY_DOCSTRING`  — NumPy style (section headers with `---` underlines)
//! - `PLAIN_DOCSTRING`  — no recognised section markers (summary/extended
//!   summary only, or unrecognised styles such as Sphinx)

use pydocstring::parse::parse;
use pydocstring::syntax::SyntaxKind;

fn show(label: &str, input: &str) {
    let parsed = parse(input);
    let kind = parsed.root().kind();
    let style_label = match kind {
        SyntaxKind::GOOGLE_DOCSTRING => "Google",
        SyntaxKind::NUMPY_DOCSTRING => "NumPy",
        SyntaxKind::PLAIN_DOCSTRING => "Plain",
        _ => "Unknown",
    };

    println!(
        "── {} → {} ──────────────────────────────────────────",
        label, style_label
    );
    print!("{}", parsed.pretty_print());
    println!();
}

fn main() {
    println!("╔══════════════════════════════════════════════════╗");
    println!("║        Auto-detecting Docstring Style            ║");
    println!("╚══════════════════════════════════════════════════╝");
    println!();

    show(
        "Google",
        r#"
Calculate the area of a rectangle.

Args:
    width (float): The width of the rectangle.
    height (float): The height of the rectangle.

Returns:
    float: The area of the rectangle.
"#,
    );

    show(
        "NumPy",
        r#"
Calculate the area of a rectangle.

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

Returns
-------
float
    The area of the rectangle.
"#,
    );

    show("Plain (summary only)", "Calculate the area of a rectangle.");

    show(
        "Plain (summary + extended)",
        r#"
Calculate the area of a rectangle.

Takes width and height as arguments and returns their product.
Negative values will raise a ValueError.
"#,
    );
}