pylint.extensions._check_docs_utils.NumpyDocstring

class documentation

class NumpyDocstring(GoogleDocstring): (source)

View In Hierarchy

Undocumented

Static Method min_section_indent Undocumented
Method match_param_docs Matches parameter documentation section to parameter documentation rules.
Class Variable re_default_value Undocumented
Class Variable re_param_line Undocumented
Class Variable re_param_section 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
Class Variable _re_section_template Undocumented

Inherited from GoogleDocstring:

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 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_property_returns_line Undocumented
Method _first_line Undocumented
Method _parse_section Undocumented

Inherited from Docstring (via GoogleDocstring):

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)
overrides pylint.extensions._check_docs_utils.GoogleDocstring.min_section_indent

Undocumented

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

Matches parameter documentation section to parameter documentation rules.

re_default_value: str = (source)

Undocumented

re_param_line = (source)
overrides pylint.extensions._check_docs_utils.GoogleDocstring.re_param_line

Undocumented

re_param_section = (source)
overrides pylint.extensions._check_docs_utils.GoogleDocstring.re_param_section

Undocumented

re_raise_line = (source)
overrides pylint.extensions._check_docs_utils.GoogleDocstring.re_raise_line

Undocumented

re_raise_section = (source)
overrides pylint.extensions._check_docs_utils.GoogleDocstring.re_raise_section

Undocumented

re_returns_line = (source)
overrides pylint.extensions._check_docs_utils.GoogleDocstring.re_returns_line

Undocumented

re_returns_section = (source)
overrides pylint.extensions._check_docs_utils.GoogleDocstring.re_returns_section

Undocumented

re_yields_section = (source)
overrides pylint.extensions._check_docs_utils.GoogleDocstring.re_yields_section

Undocumented

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

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

@staticmethod
def _is_section_header(line: str) -> bool: (source)
overrides pylint.extensions._check_docs_utils.GoogleDocstring._is_section_header

Undocumented

_re_section_template: str = (source)
overrides pylint.extensions._check_docs_utils.GoogleDocstring._re_section_template

Undocumented