Skip to content

Commit 52c0c16

Browse files
committed
fix(typescript): descriptions need tag Markdown escaping
1 parent c21a3f3 commit 52c0c16

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

src/index-cjs.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ index.rules = {
122122
message: '@next should have a type',
123123
},
124124
],
125-
description: 'Requires a type for @next tags',
125+
description: 'Requires a type for `@next` tags',
126126
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-type.md#repos-sticky-header',
127127
}),
128128
'require-param': requireParam,
@@ -147,7 +147,7 @@ index.rules = {
147147
message: '@throws should have a type',
148148
},
149149
],
150-
description: 'Requires a type for @throws tags',
150+
description: 'Requires a type for `@throws` tags',
151151
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-type.md#repos-sticky-header',
152152
}),
153153
'require-yields': requireYields,
@@ -160,7 +160,7 @@ index.rules = {
160160
message: '@yields should have a type',
161161
},
162162
],
163-
description: 'Requires a type for @yields tags',
163+
description: 'Requires a type for `@yields` tags',
164164
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-type.md#repos-sticky-header',
165165
}),
166166
'sort-tags': sortTags,

src/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ index.rules = {
128128
message: '@next should have a type',
129129
},
130130
],
131-
description: 'Requires a type for @next tags',
131+
description: 'Requires a type for `@next` tags',
132132
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-type.md#repos-sticky-header',
133133
}),
134134
'require-param': requireParam,
@@ -153,7 +153,7 @@ index.rules = {
153153
message: '@throws should have a type',
154154
},
155155
],
156-
description: 'Requires a type for @throws tags',
156+
description: 'Requires a type for `@throws` tags',
157157
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-type.md#repos-sticky-header',
158158
}),
159159
'require-yields': requireYields,
@@ -166,7 +166,7 @@ index.rules = {
166166
message: '@yields should have a type',
167167
},
168168
],
169-
description: 'Requires a type for @yields tags',
169+
description: 'Requires a type for `@yields` tags',
170170
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-type.md#repos-sticky-header',
171171
}),
172172
'sort-tags': sortTags,

src/rules.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ export interface Rules {
557557
}
558558
];
559559

560-
/** Requires a type for @next tags */
560+
/** Requires a type for `@next` tags */
561561
"jsdoc/require-next-type": [];
562562

563563
/** Requires that all function parameters are documented. */
@@ -748,7 +748,7 @@ export interface Rules {
748748
}
749749
];
750750

751-
/** Requires a type for @throws tags */
751+
/** Requires a type for `@throws` tags */
752752
"jsdoc/require-throws-type": [];
753753

754754
/** Requires yields are documented. */
@@ -790,7 +790,7 @@ export interface Rules {
790790
}
791791
];
792792

793-
/** Requires a type for @yields tags */
793+
/** Requires a type for `@yields` tags */
794794
"jsdoc/require-yields-type": [];
795795

796796
/** Sorts tags by a specified sequence according to tag name. */

0 commit comments

Comments
 (0)