pdoc icon indicating copy to clipboard operation
pdoc copied to clipboard

References stop working after backticks used in link text

Open allefeld opened this issue 5 years ago • 0 comments

A similar problem to #134 occurs after backticks have been used within a link text.

Code:

`Picture` object: A
[`tikzpicture` environment](https://pgf-tikz.github.io/pgf/pgfmanual.pdf#subsubsection.12.2.1)
is represented by a `Picture` object.

Result:

image

The `Picture` before the explicit link is automatically linked to the description of that class, but after the backticks in the text of the explicit link, it just becomes a normal code span. This effect persists until the end of the respective docstring, across paragraph boundaries.

I suspect regular expressions are not sufficient to parse Markdown syntax.

A workaround is to use html <code> tags in the link text:

`Picture` object: A
[<code>tikzpicture</code> environment](https://pgf-tikz.github.io/pgf/pgfmanual.pdf#subsubsection.12.2.1)
is represented by a `Picture` object.

allefeld avatar Jul 10 '20 02:07 allefeld