docs: Clarify `no-div-regex` rule docs #17051

fasttime · 2023-04-02T15:21:12Z

Prerequisites checklist

I have read the contributing guidelines.

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)

This PR clarifies the usage of the no-div-regex rule. I thought it would be helpful to replace a confusing formulation involving "division operators" with a more accurate description of what the rule does.

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

netlify · 2023-04-02T15:21:23Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`1f95e60`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/642a76d1db26550008d03694
😎 Deploy Preview	https://deploy-preview-17051--docs-eslint.netlify.app/rules/no-div-regex
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

mdjermanovic · 2023-04-02T20:47:50Z

I thought it would be helpful to replace a confusing formulation involving "division operators" with a more accurate description of what the rule does.

Makes sense to me because there are no actual operators there, so the wording was technically incorrect.

docs/src/rules/no-div-regex.md

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

nzakas

LGTM. Leaving open for @mdjermanovic to verify his comments.

@fasttime just a note: we use docs: for all documentation changes. I've updated the PR to reflect this.

mdjermanovic

LGTM, thanks!

mdjermanovic · 2023-04-04T10:32:48Z

@nzakas shouldn't this be fix: because it changes rule meta? I recently merged a similar change as a fix:: 129e252.

nzakas · 2023-04-04T18:19:53Z

@mdjermanovic because this doesn't change any behavior, I would still use docs: because the description is part of the rule's documentation.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.37.0` -> `8.39.0`](https://renovatebot.com/diffs/npm/eslint/8.37.0/8.39.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.39.0`](https://github.com/eslint/eslint/releases/tag/v8.39.0) [Compare Source](eslint/eslint@v8.38.0...v8.39.0) #### Features - [`3f7af9f`](eslint/eslint@3f7af9f) feat: Implement `SourceCode#markVariableAsUsed()` ([#17086](eslint/eslint#17086)) (Nicholas C. Zakas) #### Documentation - [`6987dc5`](eslint/eslint@6987dc5) docs: Fix formatting in Custom Rules docs ([#17097](eslint/eslint#17097)) (Milos Djermanovic) - [`4ee92e5`](eslint/eslint@4ee92e5) docs: Update README (GitHub Actions Bot) - [`d8e9887`](eslint/eslint@d8e9887) docs: Custom Rules cleanup/expansion ([#16906](eslint/eslint#16906)) (Ben Perlmutter) - [`1fea279`](eslint/eslint@1fea279) docs: Clarify how to add to tsc agenda ([#17084](eslint/eslint#17084)) (Nicholas C. Zakas) - [`970ef1c`](eslint/eslint@970ef1c) docs: Update triage board location (Nicholas C. Zakas) - [`6d8bffd`](eslint/eslint@6d8bffd) docs: Update README (GitHub Actions Bot) #### Chores - [`60a6f26`](eslint/eslint@60a6f26) chore: upgrade [@eslint/js](https://github.com/eslint/js)[@8](https://github.com/8).39.0 ([#17102](eslint/eslint#17102)) (Milos Djermanovic) - [`d5ba5c0`](eslint/eslint@d5ba5c0) chore: package.json update for [@eslint/js](https://github.com/eslint/js) release (ESLint Jenkins) - [`f57eff2`](eslint/eslint@f57eff2) ci: run tests on Node.js v20 ([#17093](eslint/eslint#17093)) (Nitin Kumar) - [`9d1b8fc`](eslint/eslint@9d1b8fc) perf: Binary search in token store `utils.search` ([#17066](eslint/eslint#17066)) (Francesco Trotta) - [`07a4435`](eslint/eslint@07a4435) chore: Add request for minimal repro to bug report ([#17081](eslint/eslint#17081)) (Nicholas C. Zakas) - [`eac4943`](eslint/eslint@eac4943) refactor: remove unnecessary use of `SourceCode#getAncestors` in rules ([#17075](eslint/eslint#17075)) (Milos Djermanovic) - [`0a7b60a`](eslint/eslint@0a7b60a) chore: update description of `SourceCode#getDeclaredVariables` ([#17072](eslint/eslint#17072)) (Milos Djermanovic) - [`6e2df71`](eslint/eslint@6e2df71) chore: remove unnecessary references to the LICENSE file ([#17071](eslint/eslint#17071)) (Milos Djermanovic) ### [`v8.38.0`](https://github.com/eslint/eslint/releases/tag/v8.38.0) [Compare Source](eslint/eslint@v8.37.0...v8.38.0) #### Features - [`a1d561d`](eslint/eslint@a1d561d) feat: Move getDeclaredVariables and getAncestors to SourceCode ([#17059](eslint/eslint#17059)) (Nicholas C. Zakas) #### Bug Fixes - [`1c1ece2`](eslint/eslint@1c1ece2) fix: do not report on `RegExp(...args)` in `require-unicode-regexp` ([#17037](eslint/eslint#17037)) (Francesco Trotta) #### Documentation - [`7162d34`](eslint/eslint@7162d34) docs: Mention new config system is complete ([#17068](eslint/eslint#17068)) (Nicholas C. Zakas) - [`0fd6bb2`](eslint/eslint@0fd6bb2) docs: Update README (GitHub Actions Bot) - [`c83531c`](eslint/eslint@c83531c) docs: Update/remove external links, eg. point to `eslint-community` ([#17061](eslint/eslint#17061)) (Pelle Wessman) - [`a3aa6f5`](eslint/eslint@a3aa6f5) docs: Clarify `no-div-regex` rule docs ([#17051](eslint/eslint#17051)) (Francesco Trotta) - [`b0f11cf`](eslint/eslint@b0f11cf) docs: Update README (GitHub Actions Bot) - [`da8d52a`](eslint/eslint@da8d52a) docs: Update the second object instance for the "no-new" rule ([#17020](eslint/eslint#17020)) (Ahmadou Waly NDIAYE) - [`518130a`](eslint/eslint@518130a) docs: switch language based on current path ([#16687](eslint/eslint#16687)) (Percy Ma) - [`24206c4`](eslint/eslint@24206c4) docs: Update README (GitHub Actions Bot) #### Chores - [`59ed060`](eslint/eslint@59ed060) chore: upgrade [@eslint/js](https://github.com/eslint/js)[@8](https://github.com/8).38.0 ([#17069](eslint/eslint#17069)) (Milos Djermanovic) - [`88c0898`](eslint/eslint@88c0898) chore: package.json update for [@eslint/js](https://github.com/eslint/js) release (ESLint Jenkins) - [`cf682d2`](eslint/eslint@cf682d2) refactor: simplify new-parens rule schema ([#17060](eslint/eslint#17060)) (MHO) - [`0dde022`](eslint/eslint@0dde022) ci: bump actions/add-to-project from 0.4.1 to 0.5.0 ([#17055](eslint/eslint#17055)) (dependabot\[bot]) </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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1852 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>

mdjermanovic · 2023-06-08T14:00:06Z

@fasttime could you please submit this same change to docs/src/rules/no-div-regex.md again in a new PR, as we had to undo it due to #17225.

* fix: Clarify `no-div-regex` rule docs * Update opening section Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> --------- Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

fasttime · 2023-06-08T15:00:26Z

@fasttime could you please submit this same change to docs/src/rules/no-div-regex.md again in a new PR, as we had to undo it due to #17225.

Done in #17255.

* fix: Clarify `no-div-regex` rule docs * Update opening section --------- Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

fix: Clarify no-div-regex rule docs

6a799c5

eslint-github-bot bot added the bug ESLint is working incorrectly label Apr 2, 2023

fasttime added rule Relates to ESLint's core rules documentation Relates to ESLint's documentation labels Apr 2, 2023

fasttime marked this pull request as ready for review April 2, 2023 15:40

fasttime requested a review from a team as a code owner April 2, 2023 15:40

mdjermanovic added the accepted There is consensus among the team that this change meets the criteria for inclusion label Apr 2, 2023

mdjermanovic reviewed Apr 2, 2023

View reviewed changes

docs/src/rules/no-div-regex.md Outdated Show resolved Hide resolved

Update opening section

1f95e60

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

nzakas changed the title ~~fix: Clarify no-div-regex rule docs~~ docs: Clarify no-div-regex rule docs Apr 3, 2023

nzakas approved these changes Apr 3, 2023

View reviewed changes

snitin315 approved these changes Apr 4, 2023

View reviewed changes

mdjermanovic approved these changes Apr 4, 2023

View reviewed changes

mdjermanovic merged commit a3aa6f5 into main Apr 4, 2023
21 checks passed

mdjermanovic deleted the fix-no-div-regex-docs branch April 4, 2023 20:11

github-actions bot mentioned this pull request May 2, 2023

Upgraded some dependencies - Attempt 2 AurorNZ/report-updated-dependencies#638

Merged

mdjermanovic mentioned this pull request May 27, 2023

Bug: Documentation licensed under non-OSS compatible license #17225

Closed

fasttime mentioned this pull request Jun 8, 2023

docs: Clarify no-div-regex rule docs (#17051) #17255

Merged

1 task

mdjermanovic added a commit that referenced this pull request Jun 8, 2023

docs: Clarify no-div-regex rule docs (#17051) (#17255)

0bc257c

* fix: Clarify `no-div-regex` rule docs * Update opening section --------- Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

fasttime mentioned this pull request Aug 14, 2023

docs: update documentation URL in error message #17465

Merged

1 task

eslint-github-bot bot locked and limited conversation to collaborators Oct 2, 2023

eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Oct 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Clarify `no-div-regex` rule docs #17051

docs: Clarify `no-div-regex` rule docs #17051

fasttime commented Apr 2, 2023 •

edited

netlify bot commented Apr 2, 2023 •

edited

mdjermanovic commented Apr 2, 2023

nzakas left a comment

mdjermanovic left a comment

mdjermanovic commented Apr 4, 2023

nzakas commented Apr 4, 2023

mdjermanovic commented Jun 8, 2023

fasttime commented Jun 8, 2023

docs: Clarify no-div-regex rule docs #17051

docs: Clarify no-div-regex rule docs #17051

Conversation

fasttime commented Apr 2, 2023 • edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

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

netlify bot commented Apr 2, 2023 • edited

✅ Deploy Preview for docs-eslint ready!

mdjermanovic commented Apr 2, 2023

nzakas left a comment

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

mdjermanovic commented Apr 4, 2023

nzakas commented Apr 4, 2023

mdjermanovic commented Jun 8, 2023

fasttime commented Jun 8, 2023

docs: Clarify `no-div-regex` rule docs #17051

docs: Clarify `no-div-regex` rule docs #17051

fasttime commented Apr 2, 2023 •

edited

netlify bot commented Apr 2, 2023 •

edited