Skip to content

Commit 9431b08

Browse files
committed
docs(check-alignment): grammar/clarify
1 parent fc46821 commit 9431b08

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

.README/rules/check-indentation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
### `check-indentation`
22

3-
Reports invalid padding inside JSDoc block.
3+
Reports invalid padding inside JSDoc blocks.
44

5-
Ignores parts enclosed in Markdown's "code block". For example,
6-
following description is valid:
5+
Ignores parts enclosed in Markdown "code block"'s. For example,
6+
the following description is not reported:
77

88
```js
99
/**
@@ -25,13 +25,13 @@ This rule has an object option.
2525
Array of tags (e.g., `['example', 'description']`) whose content will be
2626
"hidden" from the `check-indentation` rule. Defaults to `['example']`.
2727

28-
By default, whole JSDoc block is checked for invalid padding.
29-
That would include `@example` blocks too, which would get in the way
28+
By default, the whole JSDoc block will be checked for invalid padding.
29+
That would include `@example` blocks too, which can get in the way
3030
of adding full, readable examples of code without ending up with multiple
3131
linting issues.
3232

33-
When disabled (by passing `excludeTags: []` option), following code will
34-
lint *with* padding issue:
33+
When disabled (by passing `excludeTags: []` option), the following code *will*
34+
report a padding issue:
3535

3636
```js
3737
/**

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -878,10 +878,10 @@ function quux () {
878878
<a name="eslint-plugin-jsdoc-rules-check-indentation"></a>
879879
### <code>check-indentation</code>
880880

881-
Reports invalid padding inside JSDoc block.
881+
Reports invalid padding inside JSDoc blocks.
882882

883-
Ignores parts enclosed in Markdown's "code block". For example,
884-
following description is valid:
883+
Ignores parts enclosed in Markdown "code block"'s. For example,
884+
the following description is not reported:
885885

886886
```js
887887
/**
@@ -905,13 +905,13 @@ This rule has an object option.
905905
Array of tags (e.g., `['example', 'description']`) whose content will be
906906
"hidden" from the `check-indentation` rule. Defaults to `['example']`.
907907

908-
By default, whole JSDoc block is checked for invalid padding.
909-
That would include `@example` blocks too, which would get in the way
908+
By default, the whole JSDoc block will be checked for invalid padding.
909+
That would include `@example` blocks too, which can get in the way
910910
of adding full, readable examples of code without ending up with multiple
911911
linting issues.
912912

913-
When disabled (by passing `excludeTags: []` option), following code will
914-
lint *with* padding issue:
913+
When disabled (by passing `excludeTags: []` option), the following code *will*
914+
report a padding issue:
915915

916916
```js
917917
/**

0 commit comments

Comments
 (0)