Closed windowshopr closed 2 years ago
The contents in question is obviously indented at least four spaces and thus interpreted as a verbatim code block which gets colored by HighlightJS (bold are keywords—curious what language was autodetected).
Your docstrings should render fine if you format them like so:
def foo():
"""
Paragraph introducing a list:
1. Something something.
Continuation indented 3-spaces to match list item start.
2. Something else ...
...
"""
...
I'm making some documentation on a genetic algorithm package that I've made, and I noticed that the text inside an ordered list:
Here is a snapshot of the output:
And here is that same snippet of code:
This is all within the very top """comment""" section of my source code. You'll notice I added the escape slash \ before each quote in the list in an effort to see if that would help, but I think it's a markdown/formatting thing, I'm just not sure how to fix it. The bolding thing seems weird too as I don't use ** around the words being bolded.
What can I do to fix this? Thanks!