Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-22 05:40:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Update MD024/no-duplicate-heading to remove duplicate parameter allow_different_nesting which confuses people.

Browse source
This commit is contained in:
David Anson 2023-12-05 19:23:17 -08:00
parent c39facc73f
commit f2725178b1
15 changed files with 19 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/Rules.md
View file

@ -801,8 +801,6 @@ Aliases: `no-duplicate-heading`
Parameters:
- `allow_different_nesting`: Only check sibling headings (`boolean`, default
`false`)
- `siblings_only`: Only check sibling headings (`boolean`, default `false`)
This rule is triggered if there are multiple headings in the document that have
@ -822,9 +820,8 @@ To fix this, ensure that the content of each heading is different:
## Some more text
```
If the parameter `siblings_only` (alternatively `allow_different_nesting`) is
set to `true`, heading duplication is allowed for non-sibling headings (common
in changelogs):
If the parameter `siblings_only` is set to `true`, duplication is allowed for
headings with different parents (as is common in changelogs):
```markdown
# Change log

7
doc/md024.md
View file

@ -6,8 +6,6 @@ Aliases: `no-duplicate-heading`
Parameters:
- `allow_different_nesting`: Only check sibling headings (`boolean`, default
`false`)
- `siblings_only`: Only check sibling headings (`boolean`, default `false`)
This rule is triggered if there are multiple headings in the document that have
@ -27,9 +25,8 @@ To fix this, ensure that the content of each heading is different:
## Some more text
```
If the parameter `siblings_only` (alternatively `allow_different_nesting`) is
set to `true`, heading duplication is allowed for non-sibling headings (common
in changelogs):
If the parameter `siblings_only` is set to `true`, duplication is allowed for
headings with different parents (as is common in changelogs):
```markdown
# Change log