Docs, `MD024`: explain difference between `allow_different_nesting` and `siblings_only`

DavidAnson / vscode-markdownlint

Markdown linting and style checking for Visual Studio Code

MIT License

894 stars 166 forks source link

Closed bersbersbers closed 7 months ago

bersbersbers commented 8 months ago

Currently, both parameters have the same explanation, "Only check sibling headings":

allow_different_nesting: Only check sibling headings (boolean, default false) siblings_only: Only check sibling headings (boolean, default false)

bersbersbers commented 8 months ago

I just see below this:

If the parameter siblings_only (alternatively allow_different_nesting

Does this mean the two parameters are aliases?

DavidAnson commented 8 months ago

Right, they do the same thing. One is provided for compatibility and the other for clarity.