Struct PythonDocExtensions 

pub struct PythonDocExtensions {
    pub is_generator: bool,
    pub is_async_generator: bool,
    pub class_attributes: Vec<(String, Option<String>, Option<String>)>,
    pub instance_vars: Vec<(String, Option<String>, Option<String>)>,
    pub class_vars: Vec<(String, Option<String>, Option<String>)>,
    pub methods: Vec<(String, Option<String>)>,
    pub kwargs: Vec<(String, Option<String>, Option<String>)>,
    pub version: Option<String>,
    pub since: Option<String>,
    pub warnings: Vec<String>,
    pub meta: Vec<(String, String)>,
}

@acp:summary “Python-specific extensions for docstrings”

Fields

is_generator: bool

Whether this is a generator function (has Yields)

is_async_generator: bool

Whether this is an async function (has Receives for async generators)

class_attributes: Vec<(String, Option<String>, Option<String>)>

Class attributes (for class docstrings)

instance_vars: Vec<(String, Option<String>, Option<String>)>

Instance variables

class_vars: Vec<(String, Option<String>, Option<String>)>

Class variables

methods: Vec<(String, Option<String>)>

Methods (for class docstrings)

kwargs: Vec<(String, Option<String>, Option<String>)>

Keyword arguments (separate from regular params)

version: Option<String>

Version info

since: Option<String>

Since version

warnings: Vec<String>

Warnings (distinct from notes)

meta: Vec<(String, String)>

Meta information

Trait Implementations

impl Clone for PythonDocExtensions

fn clone(&self) -> PythonDocExtensions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PythonDocExtensions

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

Formats the value using the given formatter.

impl Default for PythonDocExtensions

fn default() -> PythonDocExtensions

Returns the “default value” for a type.