Repository navigation
Combination of admonition, link, parameter type breaks long_description. #68
Description
Parsing the following doesn't work (long_description fails).
def mock_function(boo):
"""
:::note
Admonition with a [link](https://google.com).
:::
Parameters
----------
boo: int
baa
"""
passInterestingly, removal of any of the following causes things to start working again:
- link inside the admonition
- admonition block wrappers - i.e.
::: - parameter type information - i.e.
int
Activity
rr- commentedon Nov 7, 2026
Thanks for narrowing down the three triggers, which made this easy to check. The example now parses as Numpydoc with
boo: intread as a param, and removing the link, the:::wrappers or the type no longer changes the result. Since #174 the whole first paragraph is the short description, so the admonition lands inshort_descriptionandlong_descriptionisNone.