Menu

#346 reST parser warns twice for short underline

closed-fixed
nobody
None
3
2025-07-30
2018-07-29
No

reST parser warns twice if the underline for second heading is short.
I think it is a bit verbose.

Input:

$ cat helper.rst
Issue #5214
===========

django_assert_num_queries
========

Output (warnings):

$ rst2html.py helpers.rst > /dev/null
helpers.rst:5: (WARNING/2) Title underline too short.

django_assert_num_queries
========
helpers.rst:5: (WARNING/2) Title underline too short.

django_assert_num_queries
========

It seems the parser does not warn if the short underline appears at first.

Note: originately this was reported to sphinx: https://github.com/sphinx-doc/sphinx/issues/5214

Related

Bugs: #505
Patches: #213

Discussion

  • Günter Milde

    Günter Milde - 2019-07-22
    • Priority: 5 --> 3
     
  • Günter Milde

    Günter Milde - 2025-04-05

    Thank you for reporting.
    This is due to the current setup of the rST parser regarding section level handling.
    The issue is solved by a recent patch by Arne Skjærholt [patches:#213] (which still needs to be tested for side-effects).

     

    Related

    Patches: #213

  • Günter Milde

    Günter Milde - 2025-04-17
    • status: open --> open-fixed
     
  • Günter Milde

    Günter Milde - 2025-04-17

    Fixed in [r10093]. Thank you for the report.

     

    Related

    Commit: [r10093]

  • Günter Milde

    Günter Milde - 2025-07-30
    • status: open-fixed --> closed-fixed
     
  • Günter Milde

    Günter Milde - 2025-07-30

    The issue is fixed in Docutils 0.22 released 2025-07-29.
    Thank you for reporting.

     

Log in to post a comment.

MongoDB Logo MongoDB