eslint / eslint

Find and fix problems in your JavaScript code.
https://eslint.org
MIT License
24.39k stars 4.4k forks source link

docs: update wording regarding indirect eval #18394

Closed kirkwaiblinger closed 3 weeks ago

kirkwaiblinger commented 3 weeks ago

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)

Unless you already know about indirect and direct eval (as I did not when I first read this), the current wording does not make it clear that direct eval is a unique syntactic behavior that behaves like no other part of JS. The whole section was completely meaningless to me when I first read it.

I think that using quotes implies that this is a specific, named concept, that one just has to know, rather than something the reader ought to have been able to deduce themselves. Adding the link helps the reader actually find out what that concept is.

eslint-github-bot[bot] commented 3 weeks ago

Hi @kirkwaiblinger!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

netlify[bot] commented 3 weeks ago

Deploy Preview for docs-eslint ready!

Name Link
Latest commit 182aafe127dc0bd12bd61eb38d150bcc6e37443d
Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/6629ecc243d0e0000872d365
Deploy Preview https://deploy-preview-18394--docs-eslint.netlify.app
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 configuration.

eslint-github-bot[bot] commented 3 weeks ago

Hi @kirkwaiblinger!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

eslint-github-bot[bot] commented 3 weeks ago

Hi @kirkwaiblinger!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here