pydoctor.test.test_type_fields

module documentation
(source)

Undocumented

Function doc2html Undocumented
Function test_napoleon_types_warnings This is not the same as test_token_type_invalid() since this checks our integration with pydoctor and validates we **actually** trigger the warnings.
Function test_parsed_type Undocumented
Function test_parsed_type_convert_obj_tokens_to_stan Undocumented
Function test_processtypes Currently, numpy and google type parsing happens both at the string level with pydoctor.napoleon.docstring.TypeDocstring and at the docutils nodes ParsedTypeDocstring for type fields (``type`` and ``rtype``).
Function test_processtypes_corner_cases The corner cases does not trigger any warnings because they are still valid types.
Function test_processtypes_more Undocumented
Function test_processtypes_warning_unexpected_element Undocumented
Function test_processtypes_with_system Undocumented
Function test_to_node_markup Undocumented
Function test_types_to_node_no_markup Undocumented
Function typespec2htmlvianode Undocumented
Function typespec2htmlviastr Undocumented
def doc2html(doc, markup, processtypes=False): (source)

Undocumented

Parameters
doc:strUndocumented
markup:strUndocumented
processtypes:boolUndocumented
Returns
strUndocumented
def test_napoleon_types_warnings(capsys): (source)

This is not the same as test_token_type_invalid() since this checks our integration with pydoctor and validates we **actually** trigger the warnings.

Parameters
capsys:CapSysUndocumented
def test_parsed_type(): (source)

Undocumented

def test_parsed_type_convert_obj_tokens_to_stan(): (source)

Undocumented

def test_processtypes(capsys): (source)

Currently, numpy and google type parsing happens both at the string level with pydoctor.napoleon.docstring.TypeDocstring and at the docutils nodes ParsedTypeDocstring for type fields (``type`` and ``rtype``).

Parameters
capsys:CapSysUndocumented
def test_processtypes_corner_cases(capsys): (source)

The corner cases does not trigger any warnings because they are still valid types.

Warnings should be triggered in pydoctor.napoleon.docstring.TypeDocstring._trigger_warnings, we should be careful with triggering warnings because whether the type spec triggers warnings is used to check is a string is a valid type or not.

Parameters
capsys:CapSysUndocumented
def test_processtypes_more(): (source)

Undocumented

def test_processtypes_warning_unexpected_element(capsys): (source)

Undocumented

Parameters
capsys:CapSysUndocumented
def test_processtypes_with_system(capsys): (source)

Undocumented

Parameters
capsys:CapSysUndocumented
def test_to_node_markup(): (source)

Undocumented

def test_types_to_node_no_markup(): (source)

Undocumented

def typespec2htmlvianode(s, markup): (source)

Undocumented

Parameters
s:strUndocumented
markup:strUndocumented
Returns
strUndocumented
def typespec2htmlviastr(s): (source)

Undocumented

Parameters
s:strUndocumented
Returns
strUndocumented