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: max-len rule code and tabWidth as positional arguments #17331

Merged
merged 1 commit into from Jul 2, 2023

Conversation

piranna
Copy link
Contributor

@piranna piranna commented Jul 2, 2023

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)

Ability to provide code and tabWidth for max-len rule as positional arguments is mostly undocumented, although that feature is available since 7 years ago. This PR made this behaviour more explicit.

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

@piranna piranna requested a review from a team as a code owner July 2, 2023 07:15
@eslint-github-bot
Copy link

Hi @piranna!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message 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'.
  • The first letter of the tag should be in lowercase
  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

@netlify
Copy link

netlify bot commented Jul 2, 2023

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 81a994d
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/64a123f9e99c4f0008885f5a
😎 Deploy Preview https://deploy-preview-17331--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.

@piranna piranna changed the title [max-len] Especified code and tabWidth as positional arguments docs: max-len rule code and tabWidth as positional arguments Jul 2, 2023
@eslint-github-bot
Copy link

Hi @piranna!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message 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'.
  • The first letter of the tag should be in lowercase
  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

@mdjermanovic mdjermanovic added rule Relates to ESLint's core rules documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion labels Jul 2, 2023
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! I'll fix the commit message while merging.

@mdjermanovic mdjermanovic merged commit 1fc50a8 into eslint:main Jul 2, 2023
20 of 22 checks passed
@piranna piranna deleted the patch-1 branch July 2, 2023 12:14
@piranna
Copy link
Contributor Author

piranna commented Jul 2, 2023

LGTM, thanks! I'll fix the commit message while merging.

Thanks to you for fixing it! :-)

@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 30, 2023
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Dec 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants