Fix MD025 rule #1109
Fix MD025 rule #1109
Conversation
|
|
||
| # Heading 1 | ||
|
|
||
| # Heading 2 | ||
| # Heading 2 {MD025} | ||
|
|
||
| <!-- markdownlint-configure-file { | ||
| "first-line-heading": false |
There was a problem hiding this comment.
The new regression test
| } else if (token.lineNumber === 1) { | ||
| } else { |
There was a problem hiding this comment.
The fix, this condition made no sense to me.
|
Per the documentation, MD025 only applies when there is a top-level heading in the document, which it defines as an H1 on the first line: The proposed edit in this PR seems to change that behavior to prevent multiple H1 regardless of where the first is located. I can see why one might want to enforce that, but it represents a change to how this rule has always behaved and will introduce new violations like the ones in this PR. I do not think it is appropriate to redefine a rule after it has been in use for a long time, so I am inclined not to accept this change. |
I don't understand how the position of the h1 in the document is relevant to this rule. I would understand this as a bug fix.
But fair enough, I need to create a custom rule anyway mui/material-ui#40835. I'm closing. 👍 to add a params for such a case. |
This rule was doing nothing on our codebase. Spotted this in mui/material-ui#40784.
@samuelsycamore is you see recurring issues done on the docs or blog, feel free to invest time in markdown lint rules, this will help us scale quality content, we have a couple of custom ones on the codebase already (e.g. git diff format, straight quotes, table alignment, terminal language).