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: clarify func-style #18477

Merged
merged 2 commits into from
May 27, 2024
Merged

docs: clarify func-style #18477

merged 2 commits into from
May 27, 2024

Conversation

camsteffen
Copy link
Contributor

@camsteffen camsteffen commented May 19, 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)

  • Say "function expressions assigned to variables" in some cases for clarity
  • Prefer const over var in examples
  • Some tidying/rewording
  • Add a note saying the lint does not apply to all functions

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

Fixes: #18474

@camsteffen camsteffen requested a review from a team as a code owner May 19, 2024 20:27
Copy link

linux-foundation-easycla bot commented May 19, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: camsteffen / name: Cameron Steffen (d617915)
  • ✅ login: nzakas / name: Nicholas C. Zakas (ba713f2)

@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label May 19, 2024
@github-actions github-actions bot added the rule Relates to ESLint's core rules label May 19, 2024
Copy link

netlify bot commented May 19, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit ba713f2
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/6654afa905b06e000942af4c
😎 Deploy Preview https://deploy-preview-18477--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.

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

Thanks. I just left a few suggestions for clarity.

docs/src/rules/func-style.md Outdated Show resolved Hide resolved
docs/src/rules/func-style.md Outdated Show resolved Hide resolved
docs/src/rules/func-style.md Outdated Show resolved Hide resolved
docs/src/rules/func-style.md Outdated Show resolved Hide resolved
docs/src/rules/func-style.md Outdated Show resolved Hide resolved
docs/src/rules/func-style.md Outdated Show resolved Hide resolved
@Tanujkanti4441
Copy link
Contributor

Tanujkanti4441 commented May 22, 2024

Hi @camsteffen, requested changes are yet to be implemented, can you implement them?

@camsteffen
Copy link
Contributor Author

facepalm I'm sorry, I had the changes locally but didn't actually push them up.

snitin315
snitin315 previously approved these changes May 24, 2024
Copy link
Contributor

@snitin315 snitin315 left a comment

Choose a reason for hiding this comment

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

LGTM. I will leave it open for @nzakas

docs/src/rules/func-style.md Outdated Show resolved Hide resolved
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM. I applied @mdjermanovic's suggestion, so this is good to go. Thanks!

@nzakas nzakas dismissed mdjermanovic’s stale review May 27, 2024 16:07

Suggestion applied

@nzakas nzakas merged commit f06e0b5 into eslint:main May 27, 2024
17 of 19 checks passed
@camsteffen camsteffen deleted the func-style-docs branch May 27, 2024 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

Docs: func-style docs are confusing
5 participants