-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
Conversation
@@ -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: |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
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
@ljharb Here we go :) Please review the changes if there are any other changes needed. |
jsx-first-prop-new-line.md
.jsx-wrap-multilines.md
.