Skip to content

Commit 30346eb

Browse files
authored
docs(check-alignment): innerIndent option (#1472)
1 parent 784ce62 commit 30346eb

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

.README/rules/check-alignment.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,21 @@ Reports invalid alignment of JSDoc block asterisks.
88

99
Fixes alignment.
1010

11+
## Options
12+
13+
### `innerIndent`
14+
15+
Set to 0 if you wish to avoid the normal requirement for an inner indentation of
16+
one space. Defaults to 1 (one space of normal inner indentation).
17+
1118
## Context and settings
1219

1320
|||
1421
|---|---|
1522
|Context|everywhere|
1623
|Tags|N/A|
1724
|Recommended|true|
25+
|Options|`innerIndent`|
1826

1927
## Failing examples
2028

docs/rules/check-alignment.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
# <code>check-alignment</code>
44

55
* [Fixer](#user-content-check-alignment-fixer)
6+
* [Options](#user-content-check-alignment-options)
7+
* [`innerIndent`](#user-content-check-alignment-options-innerindent)
68
* [Context and settings](#user-content-check-alignment-context-and-settings)
79
* [Failing examples](#user-content-check-alignment-failing-examples)
810
* [Passing examples](#user-content-check-alignment-passing-examples)
@@ -16,6 +18,17 @@ Reports invalid alignment of JSDoc block asterisks.
1618

1719
Fixes alignment.
1820

21+
<a name="user-content-check-alignment-options"></a>
22+
<a name="check-alignment-options"></a>
23+
## Options
24+
25+
<a name="user-content-check-alignment-options-innerindent"></a>
26+
<a name="check-alignment-options-innerindent"></a>
27+
### <code>innerIndent</code>
28+
29+
Set to 0 if you wish to avoid the normal requirement for an inner indentation of
30+
one space. Defaults to 1 (one space of normal inner indentation).
31+
1932
<a name="user-content-check-alignment-context-and-settings"></a>
2033
<a name="check-alignment-context-and-settings"></a>
2134
## Context and settings
@@ -25,6 +38,7 @@ Fixes alignment.
2538
|Context|everywhere|
2639
|Tags|N/A|
2740
|Recommended|true|
41+
|Options|`innerIndent`|
2842

2943
<a name="user-content-check-alignment-failing-examples"></a>
3044
<a name="check-alignment-failing-examples"></a>

0 commit comments

Comments
 (0)