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.

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

docs: Add Rules page intro and content tweaks #16523

Merged
merged 3 commits into from Nov 16, 2022

Conversation

bpmutter
Copy link
Contributor

@bpmutter bpmutter commented Nov 9, 2022

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 autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Add short introduction to the Configuring Rules page and minor content tweaks throughout the page.

Part of #16473

Is there anything you'd like reviewers to focus on?

@eslint-github-bot eslint-github-bot bot added triage An ESLint team member will look at this issue soon documentation Relates to ESLint's documentation labels Nov 9, 2022
@netlify
Copy link

netlify bot commented Nov 9, 2022

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit b1317dd
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/63744923d9c9a300092c2f41
😎 Deploy Preview https://deploy-preview-16523--docs-eslint.netlify.app/user-guide/configuring/rules
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@bpmutter bpmutter marked this pull request as ready for review November 13, 2022 18:05
@@ -278,7 +290,7 @@ To disable all inline config comments, use the `noInlineConfig` setting. For exa
}
```

This setting is similar to [--no-inline-config](../command-line-interface#--no-inline-config) CLI option.
You can also use the [--no-inline-config](../command-line-interface#--no-inline-config) CLI option to disable rule comments, in addition to other in-line configuration.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You can also use the [--no-inline-config](../command-line-interface#--no-inline-config) CLI option to disable rule comments, in addition to other in-line configuration.
You can also use the [--no-inline-config](../command-line-interface#--no-inline-config) CLI option to disable rule comments, in addition to other in-line configurations.

Copy link
Member

Choose a reason for hiding this comment

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

I believe the singular is correct here but will let @bpmutter comment.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, this one seems tricky. Grammarly shows plural

Screenshot 2022-11-15 at 7 17 35 AM

Copy link
Member

Choose a reason for hiding this comment

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

I also feel configuration to be correct here? as we have only one configuration?

Copy link
Member

@amareshsm amareshsm Nov 15, 2022

Choose a reason for hiding this comment

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

In addition to other which makes it plural.

Copy link
Member

Choose a reason for hiding this comment

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

@harish-sethuraman only one configuration can pls you brief me?

Copy link
Member

Choose a reason for hiding this comment

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

In this place we were meaning inline-config. I guess we specify multiple inline-configs as one inline configuration? (/* eslint indent: "error", curly: "error" */)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

generally the word 'configuration' is only singular - https://www.wordhippo.com/what-is/the-plural-of/configuration.html

'configurations' usually only when there are multiple different sets of configurations.

in this case, i think both could be correct. but singular reads better to me.

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

Thanks for cleaning this up, it's much better.

I left a few suggestions. I'd like to remove "you must" and "you have to" throughout, as I think they're a little too aggressive on their own.

@@ -278,7 +290,7 @@ To disable all inline config comments, use the `noInlineConfig` setting. For exa
}
```

This setting is similar to [--no-inline-config](../command-line-interface#--no-inline-config) CLI option.
You can also use the [--no-inline-config](../command-line-interface#--no-inline-config) CLI option to disable rule comments, in addition to other in-line configuration.
Copy link
Member

Choose a reason for hiding this comment

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

I believe the singular is correct here but will let @bpmutter comment.

docs/src/user-guide/configuring/rules.md Outdated Show resolved Hide resolved
docs/src/user-guide/configuring/rules.md Outdated Show resolved Hide resolved
docs/src/user-guide/configuring/rules.md Outdated Show resolved Hide resolved
docs/src/user-guide/configuring/rules.md Outdated Show resolved Hide resolved
@snitin315 snitin315 added accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Nov 15, 2022
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
@bpmutter
Copy link
Contributor Author

applied suggestions from code review!

Copy link
Contributor

@snitin315 snitin315 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

nzakas
nzakas approved these changes Nov 16, 2022
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@nzakas nzakas merged commit b92b30f into eslint:main Nov 16, 2022
21 checks passed
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Nov 28, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.27.0` -> `8.28.0`](https://renovatebot.com/diffs/npm/eslint/8.27.0/8.28.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.28.0`](https://github.com/eslint/eslint/releases/tag/v8.28.0)

[Compare Source](eslint/eslint@v8.27.0...v8.28.0)

#### Features

-   [`63bce44`](eslint/eslint@63bce44) feat: add `ignoreClassFieldInitialValues` option to no-magic-numbers ([#&#8203;16539](eslint/eslint#16539)) (Milos Djermanovic)
-   [`8385ecd`](eslint/eslint@8385ecd) feat: multiline properties in rule `key-spacing` with option `align` ([#&#8203;16532](eslint/eslint#16532)) (Francesco Trotta)
-   [`a4e89db`](eslint/eslint@a4e89db) feat: `no-obj-calls` support `Intl` ([#&#8203;16543](eslint/eslint#16543)) (Sosuke Suzuki)

#### Bug Fixes

-   [`c50ae4f`](eslint/eslint@c50ae4f) fix: Ensure that dot files are found with globs. ([#&#8203;16550](eslint/eslint#16550)) (Nicholas C. Zakas)
-   [`9432b67`](eslint/eslint@9432b67) fix: throw error for first unmatched pattern ([#&#8203;16533](eslint/eslint#16533)) (Milos Djermanovic)
-   [`e76c382`](eslint/eslint@e76c382) fix: allow `* 1` when followed by `/` in no-implicit-coercion ([#&#8203;16522](eslint/eslint#16522)) (Milos Djermanovic)

#### Documentation

-   [`34c05a7`](eslint/eslint@34c05a7) docs: Language Options page intro and tweaks ([#&#8203;16511](eslint/eslint#16511)) (Ben Perlmutter)
-   [`3e66387`](eslint/eslint@3e66387) docs: add intro and edit ignoring files page ([#&#8203;16510](eslint/eslint#16510)) (Ben Perlmutter)
-   [`436f712`](eslint/eslint@436f712) docs: fix Header UI inconsistency ([#&#8203;16464](eslint/eslint#16464)) (Tanuj Kanti)
-   [`f743816`](eslint/eslint@f743816) docs: switch to wrench emoji for auto-fixable rules ([#&#8203;16545](eslint/eslint#16545)) (Bryan Mishkin)
-   [`bc0547e`](eslint/eslint@bc0547e) docs: improve styles for versions and languages page ([#&#8203;16553](eslint/eslint#16553)) (Nitin Kumar)
-   [`6070f58`](eslint/eslint@6070f58) docs: clarify esquery issue workaround ([#&#8203;16556](eslint/eslint#16556)) (Milos Djermanovic)
-   [`b48e4f8`](eslint/eslint@b48e4f8) docs: Command Line Interface intro and tweaks ([#&#8203;16535](eslint/eslint#16535)) (Ben Perlmutter)
-   [`b92b30f`](eslint/eslint@b92b30f) docs: Add Rules page intro and content tweaks ([#&#8203;16523](eslint/eslint#16523)) (Ben Perlmutter)
-   [`1769b42`](eslint/eslint@1769b42) docs: Integrations page introduction ([#&#8203;16548](eslint/eslint#16548)) (Ben Perlmutter)
-   [`a8d0a57`](eslint/eslint@a8d0a57) docs: make table of contents sticky on desktop ([#&#8203;16506](eslint/eslint#16506)) (Sam Chen)
-   [`a01315a`](eslint/eslint@a01315a) docs: fix route of japanese translation site ([#&#8203;16542](eslint/eslint#16542)) (Tanuj Kanti)
-   [`0515628`](eslint/eslint@0515628) docs: use emoji instead of svg for deprecated rule ([#&#8203;16536](eslint/eslint#16536)) (Bryan Mishkin)
-   [`68f1288`](eslint/eslint@68f1288) docs: set default layouts ([#&#8203;16484](eslint/eslint#16484)) (Percy Ma)
-   [`776827a`](eslint/eslint@776827a) docs: init config about specifying shared configs ([#&#8203;16483](eslint/eslint#16483)) (Percy Ma)
-   [`5c39425`](eslint/eslint@5c39425) docs: fix broken link to plugins ([#&#8203;16520](eslint/eslint#16520)) (Ádám T. Nagy)
-   [`c97c789`](eslint/eslint@c97c789) docs: Add missing no-new-native-nonconstructor docs code fence ([#&#8203;16503](eslint/eslint#16503)) (Brandon Mills)

#### Chores

-   [`e94a4a9`](eslint/eslint@e94a4a9) chore: Add tests to verify [#&#8203;16038](eslint/eslint#16038) is fixed ([#&#8203;16538](eslint/eslint#16538)) (Nicholas C. Zakas)
-   [`e13f194`](eslint/eslint@e13f194) chore: stricter validation of `meta.docs.description` in core rules ([#&#8203;16529](eslint/eslint#16529)) (Milos Djermanovic)
-   [`72dbfbc`](eslint/eslint@72dbfbc) chore: use `pkg` parameter in `getNpmPackageVersion` ([#&#8203;16525](eslint/eslint#16525)) (webxmsj)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

 **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4yOS4xIiwidXBkYXRlZEluVmVyIjoiMzQuNDAuMCJ9-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1652
Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants