aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorsblondon <sblondon@users.noreply.github.com>2016-03-30 20:09:26 +0200
committersblondon <sblondon@users.noreply.github.com>2016-03-30 20:09:26 +0200
commit403cc58b542354a130d1f2c94a559fd0ea2f16fa (patch)
tree81a5259bb7528cce44564a7539cd56ce53ec9b1f /docs
parent829743a598f1cc226a95b77afe171090a3a3204b (diff)
downloadmarkdown-403cc58b542354a130d1f2c94a559fd0ea2f16fa.tar.gz
markdown-403cc58b542354a130d1f2c94a559fd0ea2f16fa.tar.bz2
markdown-403cc58b542354a130d1f2c94a559fd0ea2f16fa.zip
Fix lazy ordered list example in documentation
The documentation is not accurate when lazy_ol=False parameter is called. The example shows the 'start' attribute to the first <li> tag. However, the attribute is in the <ol> tag: >>> import markdown >>> s = """ ... 4. Apples ... 5. Oranges ... 6. Pears""" >>> markdown.markdown(s, lazy_ol=False) u'<ol start="4">\n<li>Apples</li>\n<li>Oranges</li>\n<li>Pears</li>\n</ol>' The behaviour of the library is the correct one (https://developer.mozilla.org/fr/docs/Web/HTML/Element/ol), so the documentation need to be fixed, not the library.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/reference.txt b/docs/reference.txt
index ac5c724..7268cc6 100644
--- a/docs/reference.txt
+++ b/docs/reference.txt
@@ -247,8 +247,8 @@ The following options are available on the `markdown.markdown` function:
If `lazy_ol` is set to `False`, then markdown will output the following
HTML:
- <ol>
- <li start="4">Apples</li>
+ <ol start="4">
+ <li>Apples</li>
<li>Oranges</li>
<li>Pears</li>
</ol>