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: correct the function-call-argument-newline 'default' descriptions #13866

Merged

Conversation

@trevinhofmann
Copy link
Contributor

@trevinhofmann trevinhofmann commented Nov 19, 2020

Prerequisites checklist

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:

What changes did you make? (Give an overview)

The documentation's descriptions of options for the function-call-argument-newline rule use "default" for the "never" and "consistent" options, although these options are not defaults. The only default is "always" for this rule. If a user reads these parts of the documentation, they might incorrectly expect their desired option of "never" or "consistent" to be the default value while the tool actually uses "always".

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

Please ensure that the word "default" is correctly used throughout this document.

@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Nov 20, 2020

Thanks for the PR! Good catch, this was probably a copy & paste error.

Loading

@mdjermanovic mdjermanovic merged commit 1861b40 into eslint:master Nov 20, 2020
13 checks passed
Loading
@mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Nov 20, 2020

Thanks for contributing!

Loading

@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators May 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants