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(utils): edit getStaticValue function JSDoc description #8625

Conversation

developer-bandi
Copy link
Contributor

PR Checklist

Overview

Edit getStaticValue's jsDoc description to know Symbol('k') is not static but Symbol.for('k') is static

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @developer-bandi!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

Copy link

netlify bot commented Mar 8, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 3542bd1
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/65ec1d54840a4d000882b7ee
😎 Deploy Preview https://deploy-preview-8625--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 90 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 98 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

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

@developer-bandi developer-bandi changed the title docs(utils): Edit getStaticValue function JSDoc description docs(utils): edit getStaticValue function JSDoc description Mar 8, 2024
@@ -50,7 +50,7 @@ const getPropertyName = eslintUtils.getPropertyName as (
* If the 2nd parameter `initialScope` was given, this function tries to resolve identifier references which are in the
* given node as much as possible. In the resolving way, it does on the assumption that built-in global objects have
* not been modified.
* For example, it considers `Symbol.iterator`, ` String.raw``hello`` `, and `Object.freeze({a: 1}).a` as static.
* For example, it considers `Symbol.iterator`, `Symbol.for('k')` ` String.raw``hello`` `, and `Object.freeze({a: 1}).a` as static but `Symbol('k')` is not static.
Copy link
Member

Choose a reason for hiding this comment

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

teeny nit, otherwise LGTM!

Suggested change
* For example, it considers `Symbol.iterator`, `Symbol.for('k')` ` String.raw``hello`` `, and `Object.freeze({a: 1}).a` as static but `Symbol('k')` is not static.
* For example, it considers `Symbol.iterator`, `Symbol.for('k')`, ` String.raw``hello`` `, and `Object.freeze({a: 1}).a` as static, but `Symbol('k')` is not static.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thank you. i apply it!

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

💯 thanks!

@JoshuaKGoldberg JoshuaKGoldberg merged commit 858c9a6 into typescript-eslint:main Mar 9, 2024
59 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Repo: (ast-utils) Mention behavior around symbols in JSDoc for getStaticValue
3 participants