[docutils:feature-requests] #98 Warn on title underline too long

Günter Milde via Docutils-develop <[email protected]> Thu, 08 Aug 2024 19:26:08 -0000
Newsgroups gmane.text.docutils.devel
Message-ID </p/docutils/feature-requests/98/5c2fe332bde071939c360c57a748fdc4c7e71368.feature-requests@docutils.p.sourceforge.net>
- **status**: pending --> closed-wont-fix
- **Comment**:

Warnings are created for issues where there is invalid rST or ambiguity about the author's intention. A too short title underline is invalid.
A "too long" title underline is valid rST syntax and the probability that the author intended it to be something other than a title underline is too low to merit a warning.



---

**[feature-requests:#98] Warn on title underline too long**

**Status:** closed-wont-fix
**Group:** Default
**Created:** Sat Oct 28, 2023 10:14 AM UTC by xypron
**Last Updated:** Thu Nov 09, 2023 05:05 PM UTC
**Owner:** nobody


If title underlines are too short, docutils creates a warning:

docutils/parsers/rst/states.py:2750:
        msg = self.reporter.warning('Title underline too short.', 

Many documentation projects want the underline to match the title. It would be great if we could have a warning for titles that are too long too.  Maybe some switch would be needed to disable the warning.



---

Sent from sourceforge.net because [email protected] is subscribed to https://sourceforge.net/p/docutils/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.