-
-
Notifications
You must be signed in to change notification settings - Fork 54
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
Generic/ArrayIndent: add XML documentation #432
base: master
Are you sure you want to change the base?
Generic/ArrayIndent: add XML documentation #432
Conversation
<documentation title="Array Indent"> | ||
<standard> | ||
<![CDATA[ | ||
The opening square bracket/parenthesis of a multi-line array must be indented at least to the same level of the start of the statement. |
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.
I opted to use opening square bracket/parenthesis
here and in a few other places as the sniff supports both array syntaxes. That is not super correct as in the old syntax, the opening token of an array is not just a parenthesis, but actually array(
.
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.
What about using the phrase "open brace" (and "close brace" for the end, of course) ? Would that work ? What do you think ?
<documentation title="Array Indent"> | ||
<standard> | ||
<![CDATA[ | ||
The opening square bracket/parenthesis of a multi-line array must be indented at least to the same level of the start of the statement. |
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.
For this <standard>
block, I'm specifically mentioning multi-line arrays. It is the only error that could apply to a single-line array, but single-line arrays are not handled by this sniff. The example that I have in mind is:
$a =
[1, 2];
Description
This PR adds the XML documentation for the Generic.Arrays.ArrayIndent sniff.
I left some inline comments below highlighting decisions I made while creating this documentation that I'm not sure about.
Suggested changelog entry
Add XML documentation for the Generic.Arrays.ArrayIndent sniff.
Related issues/external references
Part of #148
Types of changes
PR checklist