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

Add the documentation for WordPress.Arrays.CommaAfterArrayItem #1734

Merged
merged 2 commits into from
May 17, 2022
Merged

Add the documentation for WordPress.Arrays.CommaAfterArrayItem #1734

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c28fb90
Add the documentation for WordPress.Arrays.CommaAfterArrayItem
marconmartins Jun 20, 2019
7c37ddd
Docs/CommaAfterArrayItem: fixes after review
jrfnl May 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions WordPress/Docs/Arrays/CommaAfterArrayItemStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<documentation title="Comma After Array Item">
<standard>
<![CDATA[
There should be no space between an array item and the comma following it.
There should be either exactly one space, or a new line, after the comma.
]]>
</standard>
<code_comparison>
<code title="Valid: No space before a comma.">
<![CDATA[
$array = array(
'type' => 'value'<em>,</em>
'values' => array( 1 )<em>,</em>
'extra' => 'c'<em>,</em> /* Comment. */
);
]]>
</code>
<code title="Invalid: One or more spaces before a comma.">
<![CDATA[
$array = array(
'type' => 'value'<em> ,</em>
'values' => array( 1 ),
'extra' => 'c'<em> ,</em> /* Comment. */
);
]]>
</code>
</code_comparison>

<code_comparison>
<code title="Valid: Exactly one space after a comma in a single line array.">
<![CDATA[
$array = array( 'a'<em>, </em>'b'<em>, </em>'c' );
]]>
</code>
<code title="Invalid: Multiple or no spaces after a comma in a single line array.">
<![CDATA[
$array = array( 'a'<em>,</em>'b'<em>, </em>'c' );
]]>
</code>
</code_comparison>

<standard>
<![CDATA[
Single line arrays should not have a trailing comma after the last array item.
]]>
</standard>
<code_comparison>
<code title="Valid: Single line array without a trailing comma.">
<![CDATA[
$array = array( 'a', 'b', <em>'c' </em>);
]]>
</code>
<code title="Invalid: Single line array with a trailing comma.">
<![CDATA[
$array = array( 'a', 'b', <em>'c', </em>);
]]>
</code>
</code_comparison>

<standard>
<![CDATA[
Multi-line arrays must have a trailing comma after the last array item.
]]>
jrfnl marked this conversation as resolved.
Show resolved Hide resolved
</standard>
<code_comparison>
<code title="Valid: Comma after each item in a multi-line array.">
<![CDATA[
$array = array(
'a',
<em>'c',</em>
);

$assoc = array(
'type' => 'value',
'key' => <em>'c'</em>,
);
]]>
</code>

<code title="Invalid: Missing trailing comma after last item in a multi-line array.">
<![CDATA[
$array = array(
'a',
<em>'c'</em>
);

$assoc = array(
'type' => 'value',
'key' => <em>'c'</em>
);
]]>
</code>
</code_comparison>
</documentation>