pylint.extensions._check_docs_utils.GoogleDocstring

class documentation

class GoogleDocstring(Docstring): (source)

Known subclasses: pylint.extensions._check_docs_utils.NumpyDocstring

View In Hierarchy

Undocumented

Static Method min_section_indent 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.
Class Variable re_container_type Undocumented
Class Variable re_keyword_param_section Undocumented
Class Variable re_multiple_type Undocumented
Class Variable re_param_line Undocumented
Class Variable re_param_section Undocumented
Class Variable re_property_returns_line Undocumented
Class Variable re_raise_line Undocumented
Class Variable re_raise_section Undocumented
Class Variable re_returns_line Undocumented
Class Variable re_returns_section Undocumented
Class Variable re_yields_section Undocumented
Class Variable supports_yields True if the docstring supports a "yield" section.
Static Method _is_section_header Undocumented
Method _first_line Undocumented
Method _parse_section Undocumented
Class Variable _re_section_template Undocumented

Inherited from Docstring:

Method __init__ Undocumented
Method __repr__ Undocumented
Method params_documented_elsewhere Undocumented
Class Variable re_for_parameters_see Undocumented
Instance Variable doc Undocumented
@staticmethod
def min_section_indent(section_match: re.Match[str]) -> int: (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

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

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 has_yields(self) -> bool: (source)
overrides pylint.extensions._check_docs_utils.Docstring.has_yields

Undocumented

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

Undocumented

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

Undocumented

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

Returns the number of matching docstring sections.

re_container_type = (source)

Undocumented

re_keyword_param_section = (source)

Undocumented

re_multiple_type = (source)

Undocumented

re_param_line = (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

Undocumented

re_param_section = (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

Undocumented

re_property_returns_line = (source)

Undocumented

re_raise_line = (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

Undocumented

re_raise_section = (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

Undocumented

re_returns_line = (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

Undocumented

re_returns_section = (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

Undocumented

re_yields_section = (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

Undocumented

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

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

@staticmethod
def _is_section_header(_: str) -> bool: (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

Undocumented

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

Undocumented

def _parse_section(self, section_re: re.Pattern[str]) -> list[str]: (source)

Undocumented

_re_section_template: str = (source)
overridden in pylint.extensions._check_docs_utils.NumpyDocstring

Undocumented