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: updated examples of max-lines rule #17898

Merged
merged 1 commit into from Dec 22, 2023

Conversation

Tanujkanti4441
Copy link
Contributor

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)

updated the max-lines docs to count the eslint directive comments in the correct/incorrect example too.

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

Fixes #17830

@Tanujkanti4441 Tanujkanti4441 requested a review from a team as a code owner December 22, 2023 02:46
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Dec 22, 2023
Copy link

netlify bot commented Dec 22, 2023

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit d3cc776
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/6584f8854a0975000883a6fd
😎 Deploy Preview https://deploy-preview-17898--docs-eslint.netlify.app/rules/max-lines
📱 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
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, thanks!

@snitin315 snitin315 merged commit 3831fb7 into eslint:main Dec 22, 2023
17 checks passed
@Tanujkanti4441 Tanujkanti4441 deleted the max-lines-docs branch December 22, 2023 03:36
bmish added a commit to bmish/eslint that referenced this pull request Dec 27, 2023
* main:
  chore: use jsdoc/no-multi-asterisks with allowWhitespace: true (eslint#17900)
  chore: fix getting scope in tests (eslint#17899)
  fix!: Parsing 'exported' comment using parseListConfig (eslint#17675)
  docs: updated examples of `max-lines` rule (eslint#17898)
  feat!: Remove valid-jsdoc and require-jsdoc (eslint#17694)
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
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

Bug: max-lines rule also counting the eslint comments.
2 participants