Undocumented
Function | doc2html |
Undocumented |
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 |
Undocumented
Parameters | |
doc:str | Undocumented |
markup:str | Undocumented |
processtypes:bool | Undocumented |
Returns | |
str | Undocumented |
pydoctor.napoleon.docstring.TypeDocstring
and at the docutils nodes ParsedTypeDocstring
for type fields (``type`` and ``rtype``).Parameters | |
capsys:CapSys | Undocumented |
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:CapSys | Undocumented |
Undocumented
Parameters | |
capsys:CapSys | Undocumented |