Code snippet interferes with latex expressions

[franciszekjuras]

To reproduce bug, create docstring:

"""
$n \\leq 0$. 
`l` is interfering.
"""

Result:

It appears that processing l somehow eats escape characters in \\leq as one possible workaround is to write \\\\leq
If l is changed to something different, equation is rendered properly:

'''
$n \\leq 0$. 
`k` is not interfering.
'''

Similarly:

"""
$n \\geq 0$. 
`g` is interfering.
"""

[mhils]

https://pdoc.dev/docs/math/math_demo.html#using-math-in-docstrings. :-)

[mhils]

Sorry, read too quickly. Let me take a look. 🙈

[mhils]

Looks like this is a bug in markdown2, the markdown parser we use:

>>> import markdown2
>>> markdown2.markdown('$n \\leq 0$.\n`l` is interfering.')
'<p>$n leq 0$.\n<code>l</code> is interfering.</p>\n'
>>> markdown2.markdown('$n \\leq 0$.\n`xl` is interfering.')
'<p>$n \\leq 0$.\n<code>xl</code> is interfering.</p>\n'

[franciszekjuras]

Thanks. I'll open an issue upstream.
Edit: I wanted to execute your snippet on my pc, but it turns out markdown2 is not installed with pdoc. Is this package somehow embedded in pdoc?

[mhils]

pdoc includes a vendored copy at pdoc.markdown2, but this also affects the latest markdown2 release.

[mhils]

This is tracked at trentm/python-markdown2#412. The arguably annoying workaround is to not have code tags that are just a single character and maybe use $l$ again.

[mhils]

Thanks for fixing this, @Crozzers! 🍰

[Crozzers]

No problem! Just happy that the fixes for #344 made it in as well.