From 96bdb78e148acff2a6ae7d425ef80ca8553aeff0 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Thu, 21 Feb 2013 12:12:11 -0500 Subject: Update docs/index.txt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Clarify that strict 4 space indentation applies to nested lists.  Closes #193. Hopefully, people will read this in the docs before filing bug reports in the future. One can dream. --- docs/index.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/index.txt b/docs/index.txt index 90accf2..d13ab0d 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -94,6 +94,10 @@ are summarized below: subsequent paragraphs of a list **must** be indented by four spaces or one tab. + The same strict behavior is enforced on nested lists in Python-Markdown. + A sublist item **must** be nested by at last four spaces. To do otherwise + would be considered a bug. + In the event that one would prefer different behavior, [tab_length](reference.html#tab_length) can be set to whatever length is desired. Be warned however, as this will affect indentation for all aspects -- cgit v1.2.3 From 067653954bda97bbf6e9060cc4052627fbdab84b Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Thu, 21 Feb 2013 12:37:07 -0500 Subject: Better clarify the 4 space indentation rule. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A better explanation for #193 that includes all block-level elements nested in lists. --- docs/index.txt | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) (limited to 'docs') diff --git a/docs/index.txt b/docs/index.txt index d13ab0d..b0372d8 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -90,18 +90,16 @@ are summarized below: subsequent paragraph in a list item **must** be indented by either 4 spaces or one tab" (emphasis added). However, many implementations do not enforce this rule and allow less than 4 spaces of indentation. The implementers of - Python-Markdown consider it a bug to not enforce this rule, and therefore, - subsequent paragraphs of a list **must** be indented by four spaces or one - tab. + Python-Markdown consider it a bug to not enforce this rule. - The same strict behavior is enforced on nested lists in Python-Markdown. - A sublist item **must** be nested by at last four spaces. To do otherwise - would be considered a bug. + This applies to any block level elements nested in a list, including + paragraphs, sub-lists, blockquotes, code blocks, etc. They **must** always + be indented by at least four spaces (or one tab) for each level of nesting. In the event that one would prefer different behavior, [tab_length](reference.html#tab_length) can be set to whatever length is desired. Be warned however, as this will affect indentation for all aspects - of the syntax (including code blocks). + of the syntax (including root level code blocks). * __Consecutive Lists__ -- cgit v1.2.3