starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-25 17:26:22 +03:00

[GH-ISSUE #58] spurious warnings about question or exclamation marks in a header #1894

New issue

Closed

opened 2026-03-07 20:02:31 +03:00 by kerem · 5 comments

kerem commented

2026-03-07 20:02:31 +03:00

Owner

Originally created by @wbolster on GitHub (May 5, 2017).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/58

a header like this one:

# Why?

produces a MD026 warning about trailing punctutation in the header. the same happens when an exclamation mark is used.

this should not happen.

Originally created by @wbolster on GitHub (May 5, 2017). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/58 a header like this one: ``` markdown # Why? ``` produces a `MD026` warning about trailing punctutation in the header. the same happens when an exclamation mark is used. this should not happen.

kerem

2026-03-07 20:02:31 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-07 20:02:33 +03:00

Author

Owner

@DavidAnson commented on GitHub (May 5, 2017):

What do you think is wrong here?

The documentation for MD026 explicitly calls out that it will trigger for ? and !:
https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026---trailing-punctuation-in-header

If you do not like this rule, it can be disabled completely - or you can edit the list of characters it looks for (again, see documentation above).

@DavidAnson commented on GitHub (May 5, 2017): What do you think is wrong here? The documentation for `MD026` explicitly calls out that it will trigger for `?` and `!`: https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026---trailing-punctuation-in-header If you do not like this rule, it can be disabled completely - or you can edit the list of characters it looks for (again, see documentation above).

kerem commented

2026-03-07 20:02:33 +03:00

Author

Owner

@wbolster commented on GitHub (May 6, 2017):

what i think is wrong here is that the defaults are not sensible enough. :)

having a question mark at the end of a header is quite common (e.g. faqs), and requiring explicit configuration for it seems backwards to me.

@wbolster commented on GitHub (May 6, 2017): what i think is wrong here is that the defaults are not sensible enough. :) having a question mark at the end of a header is quite common (e.g. faqs), and requiring explicit configuration for it seems backwards to me.

kerem commented

2026-03-07 20:02:33 +03:00

Author

Owner

@DavidAnson commented on GitHub (May 6, 2017):

Fair enough. :) For what it's worth, this rule came from the Ruby implementation. I'll admit it's not my absolute favorite rule, but I think it's a good guideline in general, it's easy to turn off if you don't want it, and it's easy to customize when needed. I'm not inclined to break compatibility with the Ruby implementation over something like this, so unless you find that the rule is behaving wrongly, I will recommend turning it off. Sorry for the inconvenience!

@DavidAnson commented on GitHub (May 6, 2017): Fair enough. :) For what it's worth, this rule came from the Ruby implementation. I'll admit it's not my absolute favorite rule, but I think it's a good guideline in general, it's easy to turn off if you don't want it, and it's easy to customize when needed. I'm not inclined to break compatibility with the Ruby implementation over something like this, so unless you find that the rule is behaving wrongly, I will recommend turning it off. Sorry for the inconvenience!

kerem commented

2026-03-07 20:02:33 +03:00

Author

Owner

@wbolster commented on GitHub (May 6, 2017):

yeah i understand you took the rules from another project (unsure why there are 2 implementations though), but i was not aware that you aim for keeping those rules unchanged, even when they do not make sense as defaults.

thanks for the explanation.

@wbolster commented on GitHub (May 6, 2017): yeah i understand you took the rules from another project (unsure why there are 2 implementations though), but i was not aware that you aim for keeping those rules unchanged, even when they do not make sense as defaults. thanks for the explanation.

kerem commented

2026-03-07 20:02:33 +03:00

Author

Owner

@petk commented on GitHub (Apr 21, 2019):

Hello, worth noting, that headings in writings can include question marks an exclamation marks. Yes, one of the more strange settings.

@petk commented on GitHub (Apr 21, 2019): Hello, worth noting, that headings in writings can include question marks an exclamation marks. Yes, one of the more strange settings.

kerem referenced this issue

2026-03-07 20:14:41 +03:00

[PR #1894] [MERGED] Bump webpack from 5.103.0 to 5.104.0 #3627