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

Small document improvements #1199

Merged
merged 1 commit into from May 16, 2017
Merged

Conversation

preco21
Copy link
Contributor

@preco21 preco21 commented May 16, 2017

  • Fix typos and clarify default value for jsx-first-prop-new-line.md.
  • Clarify options and examples for jsx-wrap-multilines.md.

@@ -6,11 +6,12 @@ Ensure correct position of the first property.

## Rule Details

This rule checks whether the first property of all JSX elements is correctly placed. There are three possible configurations:
This rule checks whether the first property of all JSX elements is correctly placed. There are four possible configurations:
Copy link
Member

Choose a reason for hiding this comment

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

maybe instead of enumerating "four", we should just say "These are the possible configurations:" and then nobody needs to update it in the future?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it, I'll update it.

* `always`: The first property should always be placed on a new line.
* `never` : The first property should never be placed on a new line, e.g. should always be on the same line as the Component opening tag.
* `multiline`: The first property should always be placed on a new line when the JSX tag takes up multiple lines.
* `multiline-multiprop`: The first property should always be placed on a new line if the JSX tag takes up multiple lines and there are multiple properties. `default`
* `multiline-multiprop`: The first property should always be placed on a new line if the JSX tag takes up multiple lines and there are multiple properties. This is `default` value.
Copy link
Member

Choose a reason for hiding this comment

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

This is the default value.

@ljharb
Copy link
Member

ljharb commented May 16, 2017

After making the updates, please rebase this down to a single commit :-) thanks!

Clarify options and examples


Add missing changes


Apply suggestion


Merge remote-tracking branch 'preco21/docs-improvement' into docs-improvement
@preco21
Copy link
Contributor Author

preco21 commented May 16, 2017

@ljharb Here we go :) Please review the changes if there are any other changes needed.

@ljharb ljharb merged commit 2d17b7f into jsx-eslint:master May 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

3 participants