pydocstring 0.4.0

A zero-dependency Rust parser for Python docstrings (Google and NumPy styles) with a unified syntax tree and byte-precise source locations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

//! Plain docstring style.
//!
//! "Plain" covers docstrings that contain no NumPy or Google style section
//! markers — i.e. a summary, an optional extended summary, and nothing else.
//! Unrecognised styles such as Sphinx are also treated as plain.
//!
//! Internal: reached from outside through
//! [`parse_plain`](crate::parse::parse_plain) and
//! [`Parsed::to_model`](crate::syntax::Parsed::to_model).

pub(crate) mod nodes;
pub(crate) mod parser;
pub(crate) mod to_model;

pub use parser::parse_plain;