pylint.extensions._check_docs_utils.Docstring

class documentation

class Docstring: (source)

Known subclasses: pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method __repr__ Undocumented
Method exceptions Undocumented
Method has_params Undocumented
Method has_property_returns Undocumented
Method has_property_type Undocumented
Method has_returns Undocumented
Method has_rtype Undocumented
Method has_yields Undocumented
Method has_yields_type Undocumented
Method match_param_docs Undocumented
Method matching_sections Returns the number of matching docstring sections.
Method params_documented_elsewhere Undocumented
Class Variable re_for_parameters_see Undocumented
Class Variable supports_yields True if the docstring supports a "yield" section.
Instance Variable doc Undocumented
def __init__(self, doc: nodes.Const|None): (source)

Undocumented

def __repr__(self) -> str: (source)

Undocumented

def exceptions(self) -> set[str]: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

Undocumented

def has_params(self) -> bool: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

Undocumented

def has_property_returns(self) -> bool: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

Undocumented

def has_property_type(self) -> bool: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

Undocumented

def has_returns(self) -> bool: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

Undocumented

def has_rtype(self) -> bool: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

Undocumented

def has_yields(self) -> bool: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring

Undocumented

def has_yields_type(self) -> bool: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring

Undocumented

def match_param_docs(self) -> tuple[set[str], set[str]]: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

Undocumented

def matching_sections(self) -> int: (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

Returns the number of matching docstring sections.

def params_documented_elsewhere(self) -> bool: (source)

Undocumented

re_for_parameters_see = (source)

Undocumented

supports_yields: bool = (source)
overridden in pylint.extensions._check_docs_utils.GoogleDocstring, pylint.extensions._check_docs_utils.SphinxDocstring

True if the docstring supports a "yield" section. False if the docstring uses the returns section to document generators.

doc = (source)

Undocumented