Menu

#515 Wrong statement in "reStructuredText Specification"

closed-fixed
nobody
5
2025-12-15
2025-12-02
No

The rST specification states in one example that
"A footnote contains body elements, consistently indented by at least 3 spaces."
The minimal indentation in rST is one space.

Discussion

  • Günter Milde

    Günter Milde - 2025-12-02

    Proposed patch:

    -- a/docutils/docs/ref/rst/restructuredtext.rst
    +++ b/docutils/docs/ref/rst/restructuredtext.rst
    @@ -179,7 +179,10 @@ Here are examples of `body elements`_:
       - Footnotes_::
    
             .. [1] A footnote contains body elements, consistently
    -           indented by at least 3 spaces.
    +         indented by at least 1 space.
    +
    +            The least indented line sets the reference
    +            indentation, so this is a nested block quote.
    
       - Citations_::
    

    The attached patch also adds some more examples
    and moves the paragraph about paragraph alignment to the top of the section

     
  • Günter Milde

    Günter Milde - 2025-12-15
    • status: open --> closed-fixed
     
  • Günter Milde

    Günter Milde - 2025-12-15

    Fixed in [r10271].

     

    Related

    Commit: [r10271]


Log in to post a comment.