Remove claim about semicolons from docs #12944
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
eslint-deprecated
bot
added
the
triage
The documentation claimed that JS is unique among C-like languages in having optional semicolons at the end of statements. This is not true, as Go (Golang) also has optional semicolons and is C-like. This didn't seem terribly important, so rather than go on a tangent about what languages do or don't require semicolons, I just removed the claim.
Luke-Sikina
force-pushed
the
docs-correction
branch
from
675e1e9
to
a8d8376
Compare
kaicataldo
added
documentation
kaicataldo
approved these changes
Feb 20, 2020
ljharb
reviewed
Feb 20, 2020
| @@ -1,6 +1,6 @@ | |||
| # require or disallow semicolons instead of ASI (semi) | |||
|
|
|||
| JavaScript is unique amongst the C-like languages in that it doesn't require semicolons at the end of each statement. In many cases, the JavaScript engine can determine that a semicolon should be in a certain spot and will automatically add it. This feature is known as **automatic semicolon insertion (ASI)** and is considered one of the more controversial features of JavaScript. For example, the following lines are both valid: | |||
| JavaScript doesn't require semicolons at the end of each statement. In many cases, the JavaScript engine can determine that a semicolon should be in a certain spot and will automatically add it. This feature is known as **automatic semicolon insertion (ASI)** and is considered one of the more controversial features of JavaScript. For example, the following lines are both valid: | |||
There was a problem hiding this comment.
Personally, I'd prefer to phrase it as
Suggested change
| JavaScript doesn't require semicolons at the end of each statement. In many cases, the JavaScript engine can determine that a semicolon should be in a certain spot and will automatically add it. This feature is known as **automatic semicolon insertion (ASI)** and is considered one of the more controversial features of JavaScript. For example, the following lines are both valid: | |
| JavaScript requires semicolons so much that it will insert one for you if you omit it, wherever it can determine that a semicolon should be. This feature is known as **automatic semicolon insertion (ASI)** and is considered one of the more controversial features of JavaScript. For example, the following lines are both valid: |
:-p
nzakas
approved these changes
Feb 25, 2020
montmanu
pushed a commit
to montmanu/eslint
that referenced
this pull request
Mar 4, 2020
The documentation claimed that JS is unique among C-like languages in having optional semicolons at the end of statements. This is not true, as Go (Golang) also has optional semicolons and is C-like. This didn't seem terribly important, so rather than go on a tangent about what languages do or don't require semicolons, I just removed the claim.
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
The documentation claimed that JS is unique among C-like languages in having optional semicolons at the end of statements. This is not true, as Go (Golang) also has optional semicolons and is C-like.
This didn't seem terribly important, so rather than go on a tangent about what languages do or don't require semicolons, I just removed the claim.
Is there anything you'd like reviewers to focus on?
The PR is 1 line, so probably that line.