pylint.extensions._check_docs_utils.SphinxDocstring

class documentation

class SphinxDocstring(Docstring): (source)

Known subclasses: pylint.extensions._check_docs_utils.EpytextDocstring

View In Hierarchy

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 match_param_docs Undocumented
Method matching_sections Returns the number of matching docstring sections.
Class Variable re_multiple_simple_type Undocumented
Class Variable re_param_in_docstring Undocumented
Class Variable re_param_raw Undocumented
Class Variable re_property_type_in_docstring Undocumented
Class Variable re_property_type_raw Undocumented
Class Variable re_raise_in_docstring Undocumented
Class Variable re_raise_raw Undocumented
Class Variable re_returns_in_docstring Undocumented
Class Variable re_rtype_in_docstring Undocumented
Class Variable re_simple_container_type Undocumented
Class Variable re_type Undocumented
Class Variable re_type_in_docstring Undocumented
Class Variable re_type_raw Undocumented
Class Variable re_xref Undocumented
Class Variable supports_yields True if the docstring supports a "yield" section.

Inherited from Docstring:

Method __init__ Undocumented
Method __repr__ Undocumented
Method has_yields Undocumented
Method has_yields_type Undocumented
Method params_documented_elsewhere Undocumented
Class Variable re_for_parameters_see Undocumented
Instance Variable doc Undocumented
def exceptions(self) -> set[str]: (source)
overrides pylint.extensions._check_docs_utils.Docstring.exceptions

Undocumented

def has_params(self) -> bool: (source)
overrides pylint.extensions._check_docs_utils.Docstring.has_params

Undocumented

def has_property_returns(self) -> bool: (source)
overrides pylint.extensions._check_docs_utils.Docstring.has_property_returns
overridden in pylint.extensions._check_docs_utils.EpytextDocstring

Undocumented

def has_property_type(self) -> bool: (source)
overrides pylint.extensions._check_docs_utils.Docstring.has_property_type

Undocumented

def has_returns(self) -> bool: (source)
overrides pylint.extensions._check_docs_utils.Docstring.has_returns

Undocumented

def has_rtype(self) -> bool: (source)
overrides pylint.extensions._check_docs_utils.Docstring.has_rtype

Undocumented

def match_param_docs(self) -> tuple[set[str], set[str]]: (source)
overrides pylint.extensions._check_docs_utils.Docstring.match_param_docs

Undocumented

def matching_sections(self) -> int: (source)
overrides pylint.extensions._check_docs_utils.Docstring.matching_sections

Returns the number of matching docstring sections.

re_multiple_simple_type = (source)

Undocumented

re_param_in_docstring = (source)
overridden in pylint.extensions._check_docs_utils.EpytextDocstring

Undocumented

re_param_raw = (source)

Undocumented

re_property_type_in_docstring = (source)
overridden in pylint.extensions._check_docs_utils.EpytextDocstring

Undocumented

re_property_type_raw = (source)

Undocumented

re_raise_in_docstring = (source)
overridden in pylint.extensions._check_docs_utils.EpytextDocstring

Undocumented

re_raise_raw = (source)

Undocumented

re_returns_in_docstring = (source)
overridden in pylint.extensions._check_docs_utils.EpytextDocstring

Undocumented

re_rtype_in_docstring = (source)
overridden in pylint.extensions._check_docs_utils.EpytextDocstring

Undocumented

re_simple_container_type = (source)

Undocumented

re_type: str = (source)

Undocumented

re_type_in_docstring = (source)
overridden in pylint.extensions._check_docs_utils.EpytextDocstring

Undocumented

re_type_raw = (source)

Undocumented

re_xref = (source)

Undocumented

supports_yields: bool = (source)
overrides pylint.extensions._check_docs_utils.Docstring.supports_yields

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