Skip to content

Commit eb49b5f

Browse files
authored
docs: update description
Signed-off-by: Athan <[email protected]>
1 parent 1d346e5 commit eb49b5f

File tree

1 file changed

+1
-1
lines changed
  • lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest

1 file changed

+1
-1
lines changed

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest' );
3838

3939
#### rule
4040

41-
[ESLint rule][eslint-rules] to ensure that return annotations in TSDoc examples match the actual output in TypeScript declaration files (`.d.ts`). Return annotations may start with `returns`, `throws`, or `=>`. `returns` follow variable declarations or assignment expressions, whereas `=>` follow expression-only forms including `console.log` calls. The rule validates `@example` blocks in TSDoc comments within `.d.ts` files by automatically resolving the corresponding implementation via the nearest `package.json` file.
41+
[ESLint rule][eslint-rules] to ensure that return annotations in TSDoc examples match the actual output in TypeScript declaration files (`*.d.ts`). Return annotations may start with `returns`, `throws`, or `=>`. `returns` follow variable declarations or assignment expressions, whereas `=>` follow expression-only forms including `console.log` calls. The rule validates `@example` blocks in TSDoc comments within `.d.ts` files by automatically resolving the corresponding implementation via the nearest `package.json` file.
4242

4343
**Bad**:
4444

0 commit comments

Comments
 (0)