Skip to content

Commit 850c135

Browse files
committed
docs: use JavaScript code blocks in README examples
Also register the rule in the ESLint plugin namespace. --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 20b7235 commit 850c135

2 files changed

Lines changed: 18 additions & 3 deletions

File tree

  • lib/node_modules/@stdlib/_tools/eslint/rules

lib/node_modules/@stdlib/_tools/eslint/rules/doctest-annotation-spacing/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,27 @@ var rule = require( '@stdlib/_tools/eslint/rules/doctest-annotation-spacing' );
4545

4646
**Bad** (too many spaces after `returns`):
4747

48-
```text
48+
<!-- eslint-disable stdlib/doctest-annotation-spacing -->
49+
50+
```javascript
4951
var v = 3.14;
5052
// returns 3.14
5153
```
5254

5355
**Bad** (no space before `=>`):
5456

55-
```text
57+
<!-- eslint-disable stdlib/doctest-annotation-spacing, spaced-comment -->
58+
59+
```javascript
5660
console.log( 'beep' );
5761
//=> 'beep'
5862
```
5963

6064
**Bad** (too many spaces before `returns`):
6165

62-
```text
66+
<!-- eslint-disable stdlib/doctest-annotation-spacing, spaced-comment -->
67+
68+
```javascript
6369
var x = true;
6470
// returns true
6571
```

lib/node_modules/@stdlib/_tools/eslint/rules/lib/index.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,15 @@ setReadOnly( rules, 'capitalized-comments', require( '@stdlib/_tools/eslint/rule
5454
*/
5555
setReadOnly( rules, 'doctest', require( '@stdlib/_tools/eslint/rules/doctest' ) );
5656

57+
/**
58+
* @name doctest-annotation-spacing
59+
* @memberof rules
60+
* @readonly
61+
* @type {Function}
62+
* @see {@link module:@stdlib/_tools/eslint/rules/doctest-annotation-spacing}
63+
*/
64+
setReadOnly( rules, 'doctest-annotation-spacing', require( '@stdlib/_tools/eslint/rules/doctest-annotation-spacing' ) );
65+
5766
/**
5867
* @name doctest-marker
5968
* @memberof rules

0 commit comments

Comments
 (0)