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.

Sign up for GitHub

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

Jump to bottom

Docs: added less confusing explanation for func-style (fixes #12900) #13004

Merged
merged 2 commits into from Mar 10, 2020
Merged

Docs: added less confusing explanation for func-style (fixes #12900) #13004

merged 2 commits into from Mar 10, 2020

Conversation

anikethsaha
Copy link
Member

@anikethsaha anikethsaha commented Mar 5, 2020 •
edited

Prerequisites checklist

  • I have read the contributing guidelines.
  • The team has reached consensus on the changes proposed in this pull request. If not, I understand that the evaluation process will begin with this pull request and won't be merged until the team has reached consensus.

What is the purpose of this pull request? (put an "X" next to an item)

  • Documentation update
  • Bug fix (template)
  • New rule (template)
  • Changes an existing rule (template)
  • Add autofixing to a rule
  • Add a CLI option
  • Add something to the core
  • Other, please explain:

closes #12900

What changes did you make? (Give an overview)

Two commits

  • added lock files to gitignore
  • made docs changes for func-style rule

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

#12900

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Mar 5, 2020
@anikethsaha anikethsaha changed the title Docs: added clearer explanation for func-style and added lock files to gitignore Docs: added clearer explanation for func-style and lock files to gitignore Mar 5, 2020
@anikethsaha anikethsaha changed the title Docs: added clearer explanation for func-style and lock files to gitignore Chore: added clearer explanation for func-style and lock files to gitignore Mar 5, 2020
@anikethsaha
Copy link
Member Author

I am not sure whats the error in PR title !
Any help ? is it because its long ?

@mdjermanovic
Copy link
Member

I am not sure whats the error in PR title !
Any help ? is it because its long ?

Thanks for the PR! Yes, the title is too long, max length is 72.

You can find the details about the message format here:

https://eslint.org/docs/developer-guide/contributing/pull-requests#step-2-make-your-changes

Also, can you please limit the scope of this PR to just fixing the documentation issue #12900, and maybe open another issue/PR for the .gitignore problem?

It's easier to manage and discuss unrelated changes in separate PRs.

@anikethsaha
Copy link
Member Author

Thanks for the PR! Yes, the title is too long, max length is 72.

I doubted that ! 💯

Also, can you please limit the scope of this PR to just fixing the documentation issue #12900, and maybe open another issue/PR for the .gitignore problem?

Sure !

@anikethsaha anikethsaha changed the title Chore: added clearer explanation for func-style and lock files to gitignore Chore: added clearer explanation for func-style Mar 6, 2020
@mdjermanovic mdjermanovic changed the title Chore: added clearer explanation for func-style Docs: added less confusing explanation for func-style (fixes #12900) Mar 7, 2020
@mdjermanovic mdjermanovic added 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 and removed triage An ESLint team member will look at this issue soon labels Mar 7, 2020
@mdjermanovic
Copy link
Member

Thanks! I also changed the PR title.

@anikethsaha anikethsaha mentioned this pull request Mar 7, 2020
Merged
2 tasks
mdjermanovic
mdjermanovic approved these changes Mar 8, 2020
View reviewed changes
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!

@nzakas nzakas merged commit 79ac6cd into eslint:master Mar 10, 2020
anikethsaha added a commit to anikethsaha/eslint that referenced this pull request Mar 11, 2020
@anikethsaha
Docs: added less confusing explanation for func-style (fixes eslint#1…
82bf7e9 
…2900) (eslint#13004)

* Docs: added less confusing explanation for func-style

* Docs: updated func-style allowArrowFunctions info
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Sep 8, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Sep 8, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@nzakas nzakas nzakas approved these changes

@mdjermanovic mdjermanovic mdjermanovic approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Incorrect documentation for func-style
3 participants
@anikethsaha @mdjermanovic @nzakas