Skip to content

Commit 1430686

Browse files
Merge pull request #405 from G-Rath/patch-2
docs: break up a few paragraphs for easier reading
2 parents 1d5c88a + 7e51104 commit 1430686

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,7 @@ Linter-Specific Option | Description
267267

268268
### RequireInputAutocomplete
269269
This linter prevents the usage of certain types of HTML `<input>` without an `autocomplete` argument: `color`, `date`, `datetime-local`, `email`, `month`, `number`, `password`, `range`, `search`, `tel`, `text`, `time`, `url`, or `week`.
270+
270271
The HTML autocomplete helps users to complete filling in forms by using data stored in the browser. This is particularly useful for people with **motor disabilities** or **cognitive impairment** who may have difficulties filling out forms online.
271272

272273
```
@@ -452,6 +453,7 @@ This linter prevent the addition of `<script>` tags that have `type` attributes
452453

453454
It is common practice for web developers to use `<script>` tags with non-executable
454455
`type` attributes, such as `application/json` or `text/html` to pass arbitrary data into an html page.
456+
455457
Despite not being executable, these tags are subject to the same parsing quirks as executable script tags, and
456458
it is therefore more difficult to prevent security issues from creeping in. Consider for instance an application
457459
where it is possible to inject the string `</script><script>` unescaped into a `text/html` tag, the application
@@ -563,7 +565,7 @@ Good ✅
563565
</div>
564566
```
565567
566-
**Note**: This linter does not enforce the use of strict locals in view templates (files that don't start with `_`).
568+
**Note**: This linter does not enforce the use of strict locals in view templates (files that don't start with `_`).
567569
**Note**: This linter does not prevent the use of instance variables. It merely enforces that a strict locals declaration is present. It's recommended to use this linter in conjunction with the `PartialInstanceVariable` linter to enforce the use of locals.
568570
569571
## CommentSyntax
@@ -760,6 +762,7 @@ No errors were found in ERB files
760762
761763
Cached lint results are stored in the `.erb_lint_cache` directory by default, though a custom directory can be provided
762764
via the `--cache-dir` option. Cache filenames are computed with a hash of information about the file and `erb_lint` settings.
765+
763766
These files store instance attributes of the `CachedOffense` object, which only contain the `Offense` attributes
764767
necessary to restore the results of running `erb_lint` for output. The cache also automatically prunes outdated files each time it's run.
765768

0 commit comments

Comments
 (0)