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: update wording regarding indirect eval #18394

Merged

Conversation

kirkwaiblinger
Copy link
Contributor

@kirkwaiblinger kirkwaiblinger commented Apr 25, 2024

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
Copy link

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.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.

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

@github-actions github-actions bot added the documentation Relates to ESLint's documentation label Apr 25, 2024
Copy link

netlify bot commented Apr 25, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 182aafe
🔍 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
Copy link

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.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.

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

1 similar comment
@eslint-github-bot
Copy link

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.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.

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

@kirkwaiblinger kirkwaiblinger changed the title update doc on indirect eval docs: update wording regarding indirect eval Apr 25, 2024
@kirkwaiblinger kirkwaiblinger marked this pull request as ready for review April 25, 2024 05:43
@kirkwaiblinger kirkwaiblinger requested a review from a team as a code owner April 25, 2024 05:43
@mdjermanovic mdjermanovic added rule Relates to ESLint's core rules accepted There is consensus among the team that this change meets the criteria for inclusion labels Apr 25, 2024
Copy link
Member

@mdjermanovic mdjermanovic 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!

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 rule Relates to ESLint's core rules
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

None yet

2 participants