Describe the bug
mkdocstrings-python
handler does not correctly format non-primitive return types in the generated documentation table, although this functionality remains correct for native types such as str
, int
, float
, etc.
This is in contrast to the legacy mkdocstrings-python-legacy
handler that generates the return types correctly.
To Reproduce
Have a return type of typing.List
(from typing
package), for example, and notice that the generated documentation table is incorrect. It will have a description of "typing.List {user-added docstrings}", and optionally also gets incorrectly treated as "Name".
Expected behavior
Return type is not repeated and not considered as name, just like in mkdocstrings-python-legacy
.
System (please complete the following information):
mkdocstrings-python
version: 0.8.3Additional context
An example of the incorrectly generated documentation table can be found here.
Pay now to fund the work behind this issue.
Get updates on progress being made.
Maintainer is rewarded once the issue is completed.
You're funding impactful open source efforts
You want to contribute to this effort
You want to get funding like this too