@@ -878,10 +878,10 @@ function quux () {
878
878
<a name =" eslint-plugin-jsdoc-rules-check-indentation " ></a >
879
879
### <code >check-indentation</code >
880
880
881
- Reports invalid padding inside JSDoc block .
881
+ Reports invalid padding inside JSDoc blocks .
882
882
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 :
885
885
886
886
``` js
887
887
/**
@@ -905,13 +905,13 @@ This rule has an object option.
905
905
Array of tags (e.g., ` ['example', 'description'] ` ) whose content will be
906
906
"hidden" from the ` check-indentation ` rule. Defaults to ` ['example'] ` .
907
907
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
910
910
of adding full, readable examples of code without ending up with multiple
911
911
linting issues.
912
912
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:
915
915
916
916
``` js
917
917
/**
0 commit comments