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

Generic/ArrayIndent: add XML documentation #432

Merged
merged 4 commits into from
Oct 31, 2024
Merged

Generic/ArrayIndent: add XML documentation #432

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
948b2fb
Generic/ArrayIndent: add XML documentation
rodrigoprimo Apr 4, 2024
498983d
Apply suggestions from code review
rodrigoprimo Oct 10, 2024
e4fb292
Implement code review suggestions
rodrigoprimo Oct 10, 2024
da6c78d
Generic/ArrayIndent: tweak the text of the docs some more
jrfnl Oct 31, 2024
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
107 changes: 107 additions & 0 deletions src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<documentation title="Array Indent">
<standard>
<![CDATA[
The opening brace of a multi-line array must be indented at least to the same level as the start of the statement.
]]>
</standard>
<code_comparison>
<code title="Valid: Opening brace of a multi-line array indented to the same level as the start of the statement.">
<![CDATA[
$b = <em>[</em>
1,
2,
];

if ($condition) {
$a =
<em> [</em>
1,
2,
];
}

]]>
</code>
<code title="Invalid: Opening brace of a multi-line array not indented to the same level as the start of the statement.">
<![CDATA[
if ($condition) {
$a =
<em>[</em>
1,
2,
];
}
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
Each array element must be indented exactly four spaces from the start of the statement.
]]>
</standard>
<code_comparison>
<code title="Valid: Each array element is indented by exactly four spaces.">
<![CDATA[
$a = array(
<em> </em>1,
<em> </em>2,
<em> </em>3,
);
]]>
</code>
<code title="Invalid: Array elements not indented by four spaces.">
<![CDATA[
$a = array(
<em> </em>1,
<em> </em>2,
<em> </em>3,
);
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
The array closing brace must be on a new line.
]]>
</standard>
<code_comparison>
<code title="Valid: Array closing brace on its own line.">
<![CDATA[
$a = [
1,
2,<em>
]</em>;
]]>
</code>
<code title="Invalid: Array closing brace not on its own line.">
<![CDATA[
$a = [
1,
2,<em>]</em>;
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
The closing brace must be aligned with the start of the statement containing the array opener.
]]>
</standard>
<code_comparison>
<code title="Valid: Closing brace aligned with the start of the statement containing the array opener.">
<![CDATA[
$a = array(
1,
2,
<em>)</em>;
]]>
</code>
<code title="Invalid: Closing brace not aligned with the start of the statement containing the array opener.">
<![CDATA[
$a = array(
1,
2,
<em> )</em>;
]]>
</code>
</code_comparison>
</documentation>