Skip to content

Commit 8788f14

Browse files
tommccbezoerb
authored andcommitted
Grammar, style, and code fixes to README (#44)
1 parent 6f32fa4 commit 8788f14

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ gulp.src("./src/*.html")
2929
#### options
3030
See all rules here: [https://github.com/HTMLHint/HTMLHint/wiki/Rules](https://github.com/yaniswang/HTMLHint/wiki/Rules)
3131

32-
If options is empty, task use standard options.
32+
If `options` is empty, the task will use standard options.
3333

3434
##### options.htmlhintrc
35-
Type: `String`
35+
Type: `String`<br>
3636
Default value: `null`
3737

3838
If this filename is specified, options and globals defined there will be used. Task and target options override the options within the `htmlhintrc` file. The `htmlhintrc` file must be valid JSON and looks something like this:
3939

4040
```json
4141
{
42-
"tag-pair": true,
42+
"tag-pair": true
4343
}
4444
```
4545

@@ -52,11 +52,11 @@ gulp.src("./src/*.html")
5252

5353
#### customRules
5454

55-
Type: `Array` _Optional_
55+
Type: `Array` _Optional_<br>
5656
Default value: `null`
5757

58-
Array that contains all user defined custom rules. Adding a custom rule with this param doesn't require to add it's id in the `htmlhintrc` file.
59-
All defined custom rules inside this array should be a valid object and looks like this:
58+
Array that contains all user-defined custom rules. Rules added to this param need not exist in the `htmlhintrc` file.
59+
All rules inside this array should be valid objects and look like this:
6060

6161
```javascript
6262
{
@@ -86,12 +86,12 @@ gulp.src("./src/*.html")
8686
.pipe(htmlhint('.htmlhintrc', customRules))
8787
```
8888

89-
Note: You can call `htmlhint` function with 4 ways:
89+
Note: You can call `htmlhint` function four different ways:
9090

91-
- Without params (task use standard options).
91+
- Without params (task will use standard options).
9292
- With `options` param alone.
9393
- With `customRules` param alone (task will only use custom rules options).
94-
- With `options` and `customRules` params defined.
94+
- With both `options` and `customRules` params defined.
9595

9696
## Reporters
9797

@@ -105,11 +105,11 @@ gulp.src("./src/*.html")
105105
```
106106

107107

108-
### Fail reporter
108+
### Fail reporters
109109

110110
#### failOnError
111111

112-
Use this reporter if you want your task to fail in case of a HTMLHint Error (fails on first file).
112+
Use this reporter if you want your task to fail on the first file that triggers an HTMLHint Error.
113113
It also prints a summary of all errors in the first bad file.
114114

115115
```javascript
@@ -122,7 +122,7 @@ gulp.src("./src/*.html")
122122

123123
#### failAfterError
124124

125-
Use this reporter if you want your task to fail in case of a HTMLHint Error (collects statistics from all files and then fails).
125+
Use this reporter if you want to collect statistics from all files before failing.
126126
It also prints a summary of all errors in the first bad file.
127127

128128
```javascript
@@ -133,13 +133,15 @@ gulp.src("./src/*.html")
133133
.pipe(htmlhint.failAfterError())
134134
```
135135

136-
Optionally, you can pass the a config object (works for both fail reporters)
136+
#### Reporter options
137137

138-
__Plugin options:__
138+
Optionally, you can pass a config object to either fail reporter.
139139

140-
- *suppress*
140+
##### suppress
141+
Type: `Boolean`<br>
142+
Default value: `false`
141143

142-
When set to `true`, it does not display file errors on failure.
144+
When set to `true`, errors are not displayed on failure.
143145
Use in conjunction with the default and/or custom reporter(s).
144146
Prevents duplication of error messages when used along with another reporter.
145147

@@ -152,7 +154,7 @@ __Plugin options:__
152154
.pipe(htmlhint.failOnError({ suppress: true }))
153155
```
154156

155-
### Third party reporter
157+
### Third-party reporters
156158

157159
[gulp-reporter](https://github.com/gucong3000/gulp-reporter) used in team project, it fails only when error belongs to the current author of git.
158160

0 commit comments

Comments
 (0)