class documentation

class GoogleDocstringTest(BaseDocstringTest): (source)

View In Hierarchy

Undocumented

Method test_attr_with_method Undocumented
Method test_attributes_with_class_reference Undocumented
Method test_code_block_in_returns_section Undocumented
Method test_colon_in_return_type Undocumented
Method test_column_summary_lines_sphinx_issue_4016 Undocumented
Method test_docstrings Undocumented
Method test_kwargs_in_arguments Undocumented
Method test_list_in_parameter_description Undocumented
Method test_multiline_types Undocumented
Method test_multiline_types_invalid_log_warning Undocumented
Method test_parameters_with_class_reference Undocumented
Method test_raises_types Undocumented
Method test_return_formatting_indentation Undocumented
Method test_returns_section_type_only Undocumented
Method test_section_header_formatting Undocumented
Method test_sphinx_admonitions Undocumented
Method test_xrefs_in_return_type Undocumented
Class Variable docstrings Undocumented

Inherited from BaseDocstringTest:

Method assertAlmostEqualSphinxDocstring Check if the upstream version of the parser class (from sphinx.ext.napoleon) parses the docstring as expected.
Class Variable maxDiff Undocumented
def test_attr_with_method(self): (source)

Undocumented

def test_attributes_with_class_reference(self): (source)

Undocumented

def test_code_block_in_returns_section(self): (source)

Undocumented

def test_colon_in_return_type(self): (source)

Undocumented

def test_column_summary_lines_sphinx_issue_4016(self): (source)

Undocumented

def test_docstrings(self): (source)

Undocumented

def test_kwargs_in_arguments(self): (source)

Undocumented

def test_list_in_parameter_description(self): (source)

Undocumented

def test_multiline_types(self): (source)

Undocumented

def test_multiline_types_invalid_log_warning(self): (source)

Undocumented

def test_parameters_with_class_reference(self): (source)

Undocumented

def test_raises_types(self): (source)

Undocumented

def test_return_formatting_indentation(self): (source)

Undocumented

def test_returns_section_type_only(self): (source)

Undocumented

def test_section_header_formatting(self): (source)

Undocumented

def test_sphinx_admonitions(self): (source)

Undocumented

def test_xrefs_in_return_type(self): (source)

Undocumented

docstrings: list = (source)

Undocumented