docstring_parser icon indicating copy to clipboard operation
docstring_parser copied to clipboard

Combination of admonition, link, parameter type breaks long_description.

Open songololo opened this issue 3 years ago • 0 comments

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

    """
    pass

Interestingly, 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

songololo avatar Jun 14 '22 14:06 songololo