Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

Commit ae25291

Browse files
committed
Update rules for jsdoc
1 parent 42d3e35 commit ae25291

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

src/rules/jsdoc/require-returns.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,20 @@ export interface RequireReturnsOption {
2424
export type RequireReturnsOptions = [RequireReturnsOption?];
2525

2626
/**
27-
* Requires returns are documented.
27+
* Requires that returns are documented.
2828
*
2929
* @see [require-returns](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns)
3030
*/
3131
export type RequireReturnsRuleConfig = RuleConfig<RequireReturnsOptions>;
3232

3333
/**
34-
* Requires returns are documented.
34+
* Requires that returns are documented.
3535
*
3636
* @see [require-returns](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns)
3737
*/
3838
export interface RequireReturnsRule {
3939
/**
40-
* Requires returns are documented.
40+
* Requires that returns are documented.
4141
*
4242
* @see [require-returns](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns)
4343
*/

src/rules/jsdoc/require-throws.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,22 @@ export interface RequireThrowsOption {
2020
export type RequireThrowsOptions = [RequireThrowsOption?];
2121

2222
/**
23+
* Requires that throw statements are documented.
2324
*
24-
*
25-
* @see [require-throws](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns)
25+
* @see [require-throws](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-throws)
2626
*/
2727
export type RequireThrowsRuleConfig = RuleConfig<RequireThrowsOptions>;
2828

2929
/**
30+
* Requires that throw statements are documented.
3031
*
31-
*
32-
* @see [require-throws](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns)
32+
* @see [require-throws](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-throws)
3333
*/
3434
export interface RequireThrowsRule {
3535
/**
36+
* Requires that throw statements are documented.
3637
*
37-
*
38-
* @see [require-throws](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns)
38+
* @see [require-throws](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-throws)
3939
*/
4040
'jsdoc/require-throws': RequireThrowsRuleConfig;
4141
}

0 commit comments

Comments
 (0)