Skip to content

Commit e1a2123

Browse files
committed
Update wording
1 parent 065cb8e commit e1a2123

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-missing-blank-lines/README.md

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

2121
# Missing Blank Lines
2222

23-
> [ESLint rule][eslint-rules] to require blank lines between block nodes in JSDoc descriptions.
23+
> [ESLint rule][eslint-rules] to require blank lines between Markdown block nodes in JSDoc descriptions.
2424
2525
<section class="intro">
2626

@@ -38,7 +38,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-no-missing-blank-lines' )
3838

3939
#### rule
4040

41-
[ESLint rule][eslint-rules] to require blank lines between block nodes in JSDoc descriptions. By default, the rule does require blank lines between the contents of list items.
41+
[ESLint rule][eslint-rules] to require blank lines between Markdown block nodes in JSDoc descriptions. By default, the rule does require blank lines between the contents of list items.
4242

4343
**Bad**:
4444

@@ -100,7 +100,7 @@ function beep() {
100100
}
101101
```
102102

103-
The [rule][eslint-rules] may be configured using the same options as supported by [remark][remark-lint-no-missing-blank-lines]. To not require tight list items, provide `{ 'exceptTightLists': true }`.
103+
The [rule][eslint-rules] may be configured using the same options as supported by [remark][remark-lint-no-missing-blank-lines]. To allow loose list items, set the `exceptTightLists` option to `true`.
104104

105105
</section>
106106

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-missing-blank-lines/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* ESLint rule to require blank lines between block nodes in JSDoc descriptions.
22+
* ESLint rule to require blank lines between Markdown block nodes in JSDoc descriptions.
2323
*
2424
* @module @stdlib/_tools/eslint/rules/jsdoc-no-missing-blank-lines
2525
*

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-missing-blank-lines/lib/main.js

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

4343
/**
44-
* Rule to require blank lines between block nodes in JSDoc descriptions.
44+
* Rule to require blank lines between Markdown block nodes in JSDoc descriptions.
4545
*
4646
* @param {Object} context - ESLint context
4747
* @returns {Object} validators
@@ -165,7 +165,7 @@ function main( context ) {
165165
rule = {
166166
'meta': {
167167
'docs': {
168-
'description': 'require blank lines between block nodes in JSDoc descriptions'
168+
'description': 'require blank lines between Markdown block nodes in JSDoc descriptions'
169169
},
170170
'schema': [
171171
{

0 commit comments

Comments
 (0)