pydoctor.test.test_napoleon_docstring.GoogleDocstringTest

class documentation

class GoogleDocstringTest(BaseDocstringTest):

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 assert​Almost​Equal​Sphinx​Docstring Check if the upstream version of the parser class (from sphinx.ext.napoleon) parses the docstring as expected.
Class Variable max​Diff Undocumented
def test_attr_with_method(self):

Undocumented

def test_attributes_with_class_reference(self):

Undocumented

def test_code_block_in_returns_section(self):

Undocumented

def test_colon_in_return_type(self):

Undocumented

def test_column_summary_lines_sphinx_issue_4016(self):

Undocumented

def test_docstrings(self):

Undocumented

def test_kwargs_in_arguments(self):

Undocumented

def test_list_in_parameter_description(self):

Undocumented

def test_multiline_types(self):

Undocumented

def test_multiline_types_invalid_log_warning(self):

Undocumented

def test_parameters_with_class_reference(self):

Undocumented

def test_raises_types(self):

Undocumented

def test_return_formatting_indentation(self):

Undocumented

def test_returns_section_type_only(self):

Undocumented

def test_section_header_formatting(self):

Undocumented

def test_sphinx_admonitions(self):

Undocumented

def test_xrefs_in_return_type(self):

Undocumented

docstrings: list =

Undocumented