pydocstring 0.1.15

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
16
17
18
19
20
21
22
23
24
25
26

//! Google-style docstring support.
//!
//! This module contains the AST types and parser for Google-style docstrings.

pub mod kind;
pub mod nodes;
pub mod parser;
pub mod to_model;

pub use crate::parse::visitor::DocstringVisitor;
pub use crate::parse::visitor::walk;
pub use kind::GoogleSectionKind;
pub use nodes::GoogleArg;
pub use nodes::GoogleAttribute;
pub use nodes::GoogleDeprecation;
pub use nodes::GoogleDocstring;
pub use nodes::GoogleException;
pub use nodes::GoogleMethod;
pub use nodes::GoogleReference;
pub use nodes::GoogleReturn;
pub use nodes::GoogleSection;
pub use nodes::GoogleSectionHeader;
pub use nodes::GoogleSeeAlsoItem;
pub use nodes::GoogleWarning;
pub use nodes::GoogleYield;
pub use parser::parse_google;