mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-22 05:40:48 +02:00
Improve/be consistent with a few parameter descriptions.
This commit is contained in:
parent
e8cc7eb3cb
commit
c83ac3f3db
8 changed files with 22 additions and 25 deletions
11
doc/Rules.md
11
doc/Rules.md
|
@ -986,8 +986,7 @@ Aliases: `no-trailing-punctuation`
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `punctuation`: Punctuation characters not allowed at end of headings
|
- `punctuation`: Punctuation characters (`string`, default `.,;:!。,;:!`)
|
||||||
(`string`, default `.,;:!。,;:!`)
|
|
||||||
|
|
||||||
Fixable: Some violations can be fixed by tooling
|
Fixable: Some violations can be fixed by tooling
|
||||||
|
|
||||||
|
@ -2079,8 +2078,8 @@ Aliases: `emphasis-style`
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `style`: Emphasis style should be consistent (`string`, default `consistent`,
|
- `style`: Emphasis style (`string`, default `consistent`, values `asterisk` /
|
||||||
values `asterisk` / `consistent` / `underscore`)
|
`consistent` / `underscore`)
|
||||||
|
|
||||||
Fixable: Some violations can be fixed by tooling
|
Fixable: Some violations can be fixed by tooling
|
||||||
|
|
||||||
|
@ -2114,8 +2113,8 @@ Aliases: `strong-style`
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `style`: Strong style should be consistent (`string`, default `consistent`,
|
- `style`: Strong style (`string`, default `consistent`, values `asterisk` /
|
||||||
values `asterisk` / `consistent` / `underscore`)
|
`consistent` / `underscore`)
|
||||||
|
|
||||||
Fixable: Some violations can be fixed by tooling
|
Fixable: Some violations can be fixed by tooling
|
||||||
|
|
||||||
|
|
|
@ -6,8 +6,7 @@ Aliases: `no-trailing-punctuation`
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `punctuation`: Punctuation characters not allowed at end of headings
|
- `punctuation`: Punctuation characters (`string`, default `.,;:!。,;:!`)
|
||||||
(`string`, default `.,;:!。,;:!`)
|
|
||||||
|
|
||||||
Fixable: Some violations can be fixed by tooling
|
Fixable: Some violations can be fixed by tooling
|
||||||
|
|
||||||
|
|
|
@ -6,8 +6,8 @@ Aliases: `emphasis-style`
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `style`: Emphasis style should be consistent (`string`, default `consistent`,
|
- `style`: Emphasis style (`string`, default `consistent`, values `asterisk` /
|
||||||
values `asterisk` / `consistent` / `underscore`)
|
`consistent` / `underscore`)
|
||||||
|
|
||||||
Fixable: Some violations can be fixed by tooling
|
Fixable: Some violations can be fixed by tooling
|
||||||
|
|
||||||
|
|
|
@ -6,8 +6,8 @@ Aliases: `strong-style`
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `style`: Strong style should be consistent (`string`, default `consistent`,
|
- `style`: Strong style (`string`, default `consistent`, values `asterisk` /
|
||||||
values `asterisk` / `consistent` / `underscore`)
|
`consistent` / `underscore`)
|
||||||
|
|
||||||
Fixable: Some violations can be fixed by tooling
|
Fixable: Some violations can be fixed by tooling
|
||||||
|
|
||||||
|
|
|
@ -139,7 +139,7 @@
|
||||||
|
|
||||||
// MD026/no-trailing-punctuation - Trailing punctuation in heading
|
// MD026/no-trailing-punctuation - Trailing punctuation in heading
|
||||||
"MD026": {
|
"MD026": {
|
||||||
// Punctuation characters not allowed at end of headings
|
// Punctuation characters
|
||||||
"punctuation": ".,;:!。,;:!"
|
"punctuation": ".,;:!。,;:!"
|
||||||
},
|
},
|
||||||
|
|
||||||
|
@ -265,13 +265,13 @@
|
||||||
|
|
||||||
// MD049/emphasis-style - Emphasis style should be consistent
|
// MD049/emphasis-style - Emphasis style should be consistent
|
||||||
"MD049": {
|
"MD049": {
|
||||||
// Emphasis style should be consistent
|
// Emphasis style
|
||||||
"style": "consistent"
|
"style": "consistent"
|
||||||
},
|
},
|
||||||
|
|
||||||
// MD050/strong-style - Strong style should be consistent
|
// MD050/strong-style - Strong style should be consistent
|
||||||
"MD050": {
|
"MD050": {
|
||||||
// Strong style should be consistent
|
// Strong style
|
||||||
"style": "consistent"
|
"style": "consistent"
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|
|
@ -127,7 +127,7 @@ MD025:
|
||||||
|
|
||||||
# MD026/no-trailing-punctuation - Trailing punctuation in heading
|
# MD026/no-trailing-punctuation - Trailing punctuation in heading
|
||||||
MD026:
|
MD026:
|
||||||
# Punctuation characters not allowed at end of headings
|
# Punctuation characters
|
||||||
punctuation: ".,;:!。,;:!"
|
punctuation: ".,;:!。,;:!"
|
||||||
|
|
||||||
# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
|
# MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
|
||||||
|
@ -240,12 +240,12 @@ MD048:
|
||||||
|
|
||||||
# MD049/emphasis-style - Emphasis style should be consistent
|
# MD049/emphasis-style - Emphasis style should be consistent
|
||||||
MD049:
|
MD049:
|
||||||
# Emphasis style should be consistent
|
# Emphasis style
|
||||||
style: "consistent"
|
style: "consistent"
|
||||||
|
|
||||||
# MD050/strong-style - Strong style should be consistent
|
# MD050/strong-style - Strong style should be consistent
|
||||||
MD050:
|
MD050:
|
||||||
# Strong style should be consistent
|
# Strong style
|
||||||
style: "consistent"
|
style: "consistent"
|
||||||
|
|
||||||
# MD051/link-fragments - Link fragments should be valid
|
# MD051/link-fragments - Link fragments should be valid
|
||||||
|
|
|
@ -258,8 +258,7 @@ for (const rule of rules) {
|
||||||
case "MD026":
|
case "MD026":
|
||||||
scheme.properties = {
|
scheme.properties = {
|
||||||
"punctuation": {
|
"punctuation": {
|
||||||
"description":
|
"description": "Punctuation characters",
|
||||||
"Punctuation characters not allowed at end of headings",
|
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": ".,;:!。,;:!"
|
"default": ".,;:!。,;:!"
|
||||||
}
|
}
|
||||||
|
@ -461,7 +460,7 @@ for (const rule of rules) {
|
||||||
case "MD049":
|
case "MD049":
|
||||||
scheme.properties = {
|
scheme.properties = {
|
||||||
"style": {
|
"style": {
|
||||||
"description": "Emphasis style should be consistent",
|
"description": "Emphasis style",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"consistent",
|
"consistent",
|
||||||
|
@ -475,7 +474,7 @@ for (const rule of rules) {
|
||||||
case "MD050":
|
case "MD050":
|
||||||
scheme.properties = {
|
scheme.properties = {
|
||||||
"style": {
|
"style": {
|
||||||
"description": "Strong style should be consistent",
|
"description": "Strong style",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"consistent",
|
"consistent",
|
||||||
|
|
|
@ -456,7 +456,7 @@
|
||||||
"default": true,
|
"default": true,
|
||||||
"properties": {
|
"properties": {
|
||||||
"punctuation": {
|
"punctuation": {
|
||||||
"description": "Punctuation characters not allowed at end of headings",
|
"description": "Punctuation characters",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": ".,;:!。,;:!"
|
"default": ".,;:!。,;:!"
|
||||||
}
|
}
|
||||||
|
@ -876,7 +876,7 @@
|
||||||
"default": true,
|
"default": true,
|
||||||
"properties": {
|
"properties": {
|
||||||
"style": {
|
"style": {
|
||||||
"description": "Emphasis style should be consistent",
|
"description": "Emphasis style",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"consistent",
|
"consistent",
|
||||||
|
@ -900,7 +900,7 @@
|
||||||
"default": true,
|
"default": true,
|
||||||
"properties": {
|
"properties": {
|
||||||
"style": {
|
"style": {
|
||||||
"description": "Strong style should be consistent",
|
"description": "Strong style",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": [
|
"enum": [
|
||||||
"consistent",
|
"consistent",
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue