Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: Fixed typos in semi.md #17012

Merged
merged 1 commit into from Mar 27, 2023
Merged

docs: Fixed typos in semi.md #17012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/rules/semi.md
View file
Open in desktop
Expand Up @@ -76,7 +76,7 @@ This rule has two options, a string option and an object option.
String option:

* `"always"` (default) requires semicolons at the end of statements
* `"never"` disallows semicolons as the end of statements (except to disambiguate statements beginning with `[`, `(`, `/`, `+`, or `-`)
* `"never"` disallows semicolons at the end of statements (except to disambiguate statements beginning with `[`, `(`, `/`, `+`, or `-`)
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure if this was a typo. With "as", this means that the rule disallows semicolons that represent the end of a statement, which sounds right. Curious what others think about this.

Copy link
Contributor Author

@alundiak alundiak Mar 22, 2023 •
edited

Choose a reason for hiding this comment

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

I compared with other existed statements in this file, and as for me it resembles the same goal (as it's majority).

  • requires semicolons at the end of statements
  • requires semicolons at the end of statements if the next line starts with ...
  • ignores semicolons (or lacking semicolon) at the end of statements if the next line starts with ...

If as used then the English statement is NOT fully grammatically correctly ending.

Copy link
Contributor Author

@alundiak alundiak Mar 22, 2023 •
edited

Choose a reason for hiding this comment

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

But, if at usage is wrong, then I would need someone from maintainers to tell me so, coz at used more frequent.

  • at is a sign of position (in the statement), and it's OK as for me.
  • as sounds also kinda correct but in weirdly descriptive matter.

Copy link
Member

Choose a reason for hiding this comment

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

To me, both as and at sound okay here. Considering that "at the end" is used in the rest of the file without exceptions, I tend to believe that this was indeed an oversight.

Copy link
Member

Choose a reason for hiding this comment

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

Okay, let's switch to "at" for consistency.


Object option (when `"always"`):

Expand All @@ -86,7 +86,7 @@ Object option (when `"never"`):

* `"beforeStatementContinuationChars": "any"` (default) ignores semicolons (or lacking semicolon) at the end of statements if the next line starts with `[`, `(`, `/`, `+`, or `-`.
* `"beforeStatementContinuationChars": "always"` requires semicolons at the end of statements if the next line starts with `[`, `(`, `/`, `+`, or `-`.
* `"beforeStatementContinuationChars": "never"` disallows semicolons as the end of statements if it doesn't make ASI hazard even if the next line starts with `[`, `(`, `/`, `+`, or `-`.
* `"beforeStatementContinuationChars": "never"` disallows semicolons at the end of statements if it doesn't make ASI hazard even if the next line starts with `[`, `(`, `/`, `+`, or `-`.

**Note:** `beforeStatementContinuationChars` does not apply to class fields because class fields are not statements.

Expand Down