inline triple backtick foo.bar
in doc comment incorrectly identifies foo
as lang, stripping it in docs
#17314
Labels
Documentation Generation
Related to documentation generation (but not content).
Example
Current Output
doc comment in nim code:
same code as comment but in rst file:
Expected Output
current output (stripping
foo
in the 1st foo.bar is incorrect; it looks like it's interpretting foo as the language of a markdown block but that seems incorrect (eg stackoverflow doesn't do that)the question is whether to treat this case as markdown emulation or rst:
``
as delimiters:We should do what's best for nim here if there's an ambiguity.
This ties into how to escape single backticks /cc @a-mr refs #17260:
## ``` `foo.bar` ```
(the leading and trailing space are stripped out; it's a markdown feature)
Additional Information
pip3 install rst2html
cat t11956d.rst | rst2html.py > /tmp/z01.html
generates:
1.5.1 2f213db
The text was updated successfully, but these errors were encountered: