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: no-constant-condition: Add multi-comparison example #16776
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Hi @SebastianSimon!, thanks for the Pull Request The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.
To Fix: You can fix this problem by running Read more about contributing to ESLint here |
I think it would be better to merge this example into the existing code blocks. |
@SebastianSimon are you still working on this? |
I was waiting for more feedback, but I guess after the one comment with the one thumbs up, there’s not going to be anything else, therefore I just made that change, so now you can merge this, unless there’s anything else you expect me to act on. I don’t really have a strong opinion on these feedback points. Although, looking at the other examples more closely, there are quite a few of those semantic errors, just like the example I’ve added, so unifying the examples really does make more sense. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for contributing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.32.0` -> `8.33.0`](https://renovatebot.com/diffs/npm/eslint/8.32.0/8.33.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.33.0`](https://github.com/eslint/eslint/releases/tag/v8.33.0) [Compare Source](eslint/eslint@v8.32.0...v8.33.0) #### Features - [`2cc7954`](eslint/eslint@2cc7954) feat: add `restrictDefaultExports` option to no-restricted-exports rule ([#​16785](eslint/eslint#16785)) (Nitin Kumar) #### Documentation - [`17f4be2`](eslint/eslint@17f4be2) docs: Fix examples in no-multiple-empty-lines rule ([#​16835](eslint/eslint#16835)) (jonz94) - [`9c7cfe3`](eslint/eslint@9c7cfe3) docs: 'Source Code' content in 'Set up Development Environment' page ([#​16780](eslint/eslint#16780)) (Ben Perlmutter) - [`ede5c64`](eslint/eslint@ede5c64) docs: Custom processors page ([#​16802](eslint/eslint#16802)) (Ben Perlmutter) - [`2620614`](eslint/eslint@2620614) docs: Code of Conduct page ([#​16781](eslint/eslint#16781)) (Ben Perlmutter) - [`50a8efd`](eslint/eslint@50a8efd) docs: report a sec vulnerability page ([#​16808](eslint/eslint#16808)) (Ben Perlmutter) - [`ed60afd`](eslint/eslint@ed60afd) docs: Update page titles, section landing pages, and side TOC ([#​16760](eslint/eslint#16760)) (Ben Perlmutter) - [`333c712`](eslint/eslint@333c712) docs: add background to code-path-diagrams for dark-mode ([#​16822](eslint/eslint#16822)) (Tanuj Kanti) - [`f5f7b9b`](eslint/eslint@f5f7b9b) docs: Update README (GitHub Actions Bot) - [`2aa4f5f`](eslint/eslint@2aa4f5f) docs: no-constant-condition: Add multi-comparison example ([#​16776](eslint/eslint#16776)) (Sebastian Simon) - [`40287db`](eslint/eslint@40287db) docs: Remove Google Group icon ([#​16779](eslint/eslint#16779)) (Nicholas C. Zakas) - [`ea10ca5`](eslint/eslint@ea10ca5) docs: 'a .eslint' -> 'an .eslint' for consistency ([#​16809](eslint/eslint#16809)) (Ben Perlmutter) - [`3be0748`](eslint/eslint@3be0748) docs: add example for nodejs lintText api ([#​16789](eslint/eslint#16789)) (Siva K) - [`ce4f5ff`](eslint/eslint@ce4f5ff) docs: Replace removed related rules with a valid rule ([#​16800](eslint/eslint#16800)) (Ville Saalo) </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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMTUuMSIsInVwZGF0ZWRJblZlciI6IjM0LjExOS4yIn0=--> Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1759 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>
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)
I have added the common beginners’ mistake of incorrectly comparing a value against multiple other values. ESLint triggers the no-constant-condition error for code such as this, but the documentation doesn’t clearly point out what is wrong and how to fix it.
Given the large number of duplicates on Stack Overflow, I feel like this is an important example missing from the documentation.
Is there anything you'd like reviewers to focus on?
Feel free to edit as needed!