Skip to content

Update html-end-tags doc #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 16, 2017
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions docs/rules/html-end-tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,12 @@

- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

This rule enforce the way of end tags.

- [Void elements] disallow end tags.
- Other elements require end tags.

## :book: Rule Details

This rule reports the following elements:
This rule reports:

- [Void elements] which have end tags.
- Other elements which do not have end tags and are not self-closing.
- presence of end tags on [Void elements](https://www.w3.org/TR/html51/syntax.html#void-elements)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe better to say "an and tag"?

- absence of end tags or self-closed endings on other elements
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be clearer to say:

absence of both an end tag (e.g. </div>) and self-closing opening tag (e.g. <div/>) on other elements


:-1: Examples of **incorrect** code for this rule:

Expand Down Expand Up @@ -46,9 +41,3 @@ This rule reports the following elements:
## :wrench: Options

Nothing.

[Void elements]: https://www.w3.org/TR/html51/syntax.html#void-elements

## TODO: `<br></br>`

`parse5` does not recognize the illegal end tags of void elements.