class documentation

class NumpyDocstringTest(BaseDocstringTest): (source)

View In Hierarchy

Undocumented

Method test_colon_in_return_type Undocumented
Method test_docstring_token_type_invalid_warnings_with_linenum Undocumented
Method test_docstrings Undocumented
Method test_escape_args_and_kwargs Undocumented
Method test_fields_blank_lines Test for issue https://github.com/twisted/pydoctor/issues/366
Method test_fields_blank_lines_sphinx_upstream Test that sphinx napoleon upstream version of NumpyDocstring is actually generating wrong reST text (for now)...
Method test_issue_with_link_end_of_section Undocumented
Method test_list_in_parameter_description Undocumented
Method test_multiple_parameters Undocumented
Method test_parameter_types Undocumented
Method test_parameters_with_class_reference Undocumented
Method test_parameters_without_class_reference Undocumented
Method test_raises_types Undocumented
Method test_return_no_type_sphinx_issue_7077 Undocumented
Method test_return_type_annotation_style Undocumented
Method test_return_type_list_free_style_do_desc Undocumented
Method test_return_types Undocumented
Method test_section_header_underline_length Undocumented
Method test_see_also_refs Undocumented
Method test_see_also_refs_invalid Undocumented
Method test_sphinx_admonitions Undocumented
Method test_underscore_in_attribute Undocumented
Method test_xrefs_in_return_type Undocumented
Method test_yield_types Undocumented
Class Variable docstrings Undocumented
Class Variable docstrings_returns Undocumented
Class Variable escape_kwargs_tests_cases 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_colon_in_return_type(self): (source)

Undocumented

def test_docstring_token_type_invalid_warnings_with_linenum(self): (source)

Undocumented

def test_docstrings(self): (source)

Undocumented

def test_escape_args_and_kwargs(self): (source)

Undocumented

def test_fields_blank_lines(self): (source)
def test_fields_blank_lines_sphinx_upstream(self): (source)

Test that sphinx napoleon upstream version of NumpyDocstring is actually generating wrong reST text (for now)...

def test_issue_with_link_end_of_section(self): (source)

Undocumented

def test_list_in_parameter_description(self): (source)

Undocumented

def test_multiple_parameters(self): (source)

Undocumented

def test_parameter_types(self): (source)

Undocumented

def test_parameters_with_class_reference(self): (source)

Undocumented

def test_parameters_without_class_reference(self): (source)

Undocumented

def test_raises_types(self): (source)

Undocumented

def test_return_no_type_sphinx_issue_7077(self): (source)

Undocumented

def test_return_type_annotation_style(self): (source)

Undocumented

def test_return_type_list_free_style_do_desc(self): (source)

Undocumented

def test_return_types(self): (source)

Undocumented

def test_section_header_underline_length(self): (source)

Undocumented

def test_see_also_refs(self): (source)

Undocumented

def test_see_also_refs_invalid(self): (source)

Undocumented

def test_sphinx_admonitions(self): (source)

Undocumented

def test_underscore_in_attribute(self): (source)

Undocumented

def test_xrefs_in_return_type(self): (source)

Undocumented

def test_yield_types(self): (source)

Undocumented

docstrings: list = (source)

Undocumented

docstrings_returns: list = (source)

Undocumented

escape_kwargs_tests_cases: list = (source)

Undocumented