Skip to content

Commit a324f99

Browse files
Planeshifterkgryte
andauthored
chore: apply suggestions from code review
Co-authored-by: Athan <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent 2983ed7 commit a324f99

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# jsdoc-example-require-spacing
2222

23-
> [ESLint rule][eslint-rules] to enforce empty lines between requires and code in JSDoc examples.
23+
> [ESLint rule][eslint-rules] to enforce empty lines between `require` statements and code in JSDoc examples.
2424
2525
<section class="intro">
2626

@@ -38,7 +38,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing'
3838

3939
#### rule
4040

41-
[ESLint rule][eslint-rules] to enforce empty lines between requires and code in JSDoc examples.
41+
[ESLint rule][eslint-rules] to enforce empty lines between `require` statements and code in JSDoc examples.
4242

4343
**Bad**:
4444

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var rule = require( './main.js' );
2626
// MAIN //
2727

2828
/**
29-
* ESLint rule to enforce empty lines between requires and code in JSDoc examples.
29+
* ESLint rule to enforce empty lines between `require` statements and code in JSDoc examples.
3030
*
3131
* @module @stdlib/_tools/eslint/rules/jsdoc-example-require-spacing
3232
*

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ var rule;
4141
// MAIN //
4242

4343
/**
44-
* Rule to enforce empty lines between requires and code in JSDoc examples.
44+
* Rule to enforce empty lines between `require` statements and code in JSDoc examples.
4545
*
4646
* @param {Object} context - ESLint context
4747
* @returns {Object} rule object
@@ -117,7 +117,7 @@ function main( context ) {
117117
}
118118

119119
/**
120-
* Checks if a JSDoc comment contains examples with require statements not followed by empty lines.
120+
* Checks if a JSDoc comment contains examples with `require` statements which are not followed by empty lines.
121121
*
122122
* @private
123123
* @param {Object} node - node to examine

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing",
33
"version": "0.0.0",
4-
"description": "ESLint rule to enforce empty lines between requires and code in JSDoc examples.",
4+
"description": "ESLint rule to enforce empty lines between `require` statements and code in JSDoc examples.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)