class documentation

class NumpyDocstringTest(BaseDocstringTest):

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 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_colon_in_return_type(self):

Undocumented

def test_docstring_token_type_invalid_warnings_with_linenum(self):

Undocumented

def test_docstrings(self):

Undocumented

def test_escape_args_and_kwargs(self):

Undocumented

def test_fields_blank_lines(self):
def test_fields_blank_lines_sphinx_upstream(self):
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):

Undocumented

def test_list_in_parameter_description(self):

Undocumented

def test_multiple_parameters(self):

Undocumented

def test_parameter_types(self):

Undocumented

def test_parameters_with_class_reference(self):

Undocumented

def test_parameters_without_class_reference(self):

Undocumented

def test_raises_types(self):

Undocumented

def test_return_no_type_sphinx_issue_7077(self):

Undocumented

def test_return_type_annotation_style(self):

Undocumented

def test_return_type_list_free_style_do_desc(self):

Undocumented

def test_return_types(self):

Undocumented

def test_section_header_underline_length(self):

Undocumented

def test_see_also_refs(self):

Undocumented

def test_see_also_refs_invalid(self):

Undocumented

def test_sphinx_admonitions(self):

Undocumented

def test_underscore_in_attribute(self):

Undocumented

def test_xrefs_in_return_type(self):

Undocumented

def test_yield_types(self):

Undocumented

docstrings: list =

Undocumented

docstrings_returns: list =

Undocumented

escape_kwargs_tests_cases: list =

Undocumented