docutils-develop

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

[xypron <xy...@us...>]

---

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

**Status:** open
**Group:** Default
**Created:** Sat Oct 28, 2023 10:14 AM UTC by xypron
**Last Updated:** Sat Oct 28, 2023 10:14 AM 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 doc...@li... 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.

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

[Günter M. <mi...@us...>]

Thank you for the suggestion. It would need a lot of thinking about detail to get it right:

What should be done with headers like

     ***************
          this
     ***************
(no warning, warning if left an right overhang differs, ...)?

How about styles where a title underline should always be 75 characters wide?

Is it really worth defining a new setting for "don't warn about too long underlines".
Would this open the way to a setting for disabling every single warning type?

Should we opt for a generic setting "--disable-warning-of-type" and define names for the warning types/classes that can be used in this setting? ...

I would class a too long underline rather as a stylistic issue, that similar to line-length,
TAB use etc. should be enforced by external means, not the Docutils core.




---

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

**Status:** open
**Group:** Default
**Created:** Sat Oct 28, 2023 10:14 AM UTC by xypron
**Last Updated:** Sat Oct 28, 2023 10:14 AM 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 doc...@li... 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.

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

[Günter M. <mi...@us...>]

- **status**: open --> pending



---

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

**Status:** pending
**Group:** Default
**Created:** Sat Oct 28, 2023 10:14 AM UTC by xypron
**Last Updated:** Sun Oct 29, 2023 10:45 AM 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 doc...@li... 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.

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

[Günter M. <mi...@us...>]

- **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 doc...@li... 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.