From 948b2fbddd26f3e6a410169817f69e7029308779 Mon Sep 17 00:00:00 2001
From: Rodrigo Primo <rodrigosprimo@gmail.com>
Date: Thu, 4 Apr 2024 12:47:58 -0300
Subject: [PATCH 1/4] Generic/ArrayIndent: add XML documentation

---
 .../Docs/Arrays/ArrayIndentStandard.xml       | 101 ++++++++++++++++++
 1 file changed, 101 insertions(+)
 create mode 100644 src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml

diff --git a/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
new file mode 100644
index 0000000000..5fffc44907
--- /dev/null
+++ b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
@@ -0,0 +1,101 @@
+<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.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Opening square bracket/parenthesis token of a multi-line array indented at least to the same level of the start of the statement.">
+        <![CDATA[
+if ($condition) {
+    $a =
+<em>    [</em>
+        1,
+        2,
+    ];
+}
+        ]]>
+        </code>
+        <code title="Invalid: Opening square bracket/parenthesis of a multi-line array not indented at least to the same level of the start of the statement.">
+        <![CDATA[
+if ($condition) {
+    $a =
+<em>[</em>
+        1,
+        2,
+    ];
+}
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    The elements of an array must be indented four spaces beyond the indentation level of the opening square bracket/parenthesis.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Elements of an array indented four spaces beyond the indentation level of the opening square bracket/parenthesis.">
+        <![CDATA[
+$a = array(
+<em>    1</em>,
+<em>    2</em>,
+<em>    3</em>,
+);
+        ]]>
+        </code>
+        <code title="Invalid: Elements of an array not indented four spaces beyond the indentation level of the opening square bracket/parenthesis.">
+        <![CDATA[
+$a = array(
+<em>  1</em>,
+    2,
+<em>        3</em>,
+);
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    There must be a newline before the array closing square bracket/parenthesis.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Newline before the array closing square bracket/parenthesis.">
+        <![CDATA[
+$a = [
+    1,
+    2,<em>
+]</em>;
+        ]]>
+        </code>
+        <code title="Invalid: No newline before the array closing square bracket/parenthesis.">
+        <![CDATA[
+$a = [
+    1,
+    2,<em>]</em>;
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    The closing square bracket/parenthesis must be indented four spaces less than the array elements.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Closing square bracket/parenthesis indented four spaces less than the array elements.">
+        <![CDATA[
+$a = array(
+    1,
+    2,
+<em>)</em>;
+        ]]>
+        </code>
+        <code title="Invalid: Closing square bracket/parenthesis not indented four spaces less than the array elements.">
+        <![CDATA[
+$a = array(
+    1,
+    2,
+<em>  )</em>;
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>

From 498983df5584c2ab0096124524545cff32fa3384 Mon Sep 17 00:00:00 2001
From: Rodrigo Primo <rodrigosprimo@gmail.com>
Date: Thu, 10 Oct 2024 09:08:38 -0300
Subject: [PATCH 2/4] Apply suggestions from code review

Co-authored-by: Juliette <663378+jrfnl@users.noreply.github.com>
---
 src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
index 5fffc44907..66d45d60fa 100644
--- a/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
+++ b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
@@ -5,7 +5,7 @@
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: Opening square bracket/parenthesis token of a multi-line array indented at least to the same level of the start of the statement.">
+        <code title="Valid: Opening square bracket/parenthesis token of a multi-line array indented at least to the same level as the start of the statement.">
         <![CDATA[
 if ($condition) {
     $a =
@@ -16,7 +16,7 @@ if ($condition) {
 }
         ]]>
         </code>
-        <code title="Invalid: Opening square bracket/parenthesis of a multi-line array not indented at least to the same level of the start of the statement.">
+        <code title="Invalid: Opening square bracket/parenthesis of a multi-line array not indented at least to the same level as the start of the statement.">
         <![CDATA[
 if ($condition) {
     $a =

From e4fb292817df577489962fc27fca1248859b1014 Mon Sep 17 00:00:00 2001
From: Rodrigo Primo <rodrigosprimo@gmail.com>
Date: Thu, 10 Oct 2024 09:02:54 -0300
Subject: [PATCH 3/4] Implement code review suggestions

---
 .../Docs/Arrays/ArrayIndentStandard.xml       | 39 +++++++++++--------
 1 file changed, 22 insertions(+), 17 deletions(-)

diff --git a/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
index 66d45d60fa..ffb6e35c36 100644
--- a/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
+++ b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
@@ -1,11 +1,11 @@
 <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.
+    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 square bracket/parenthesis token of a multi-line array indented at least to the same level as the start of the statement.">
+        <code title="Valid: Opening brace of a multi-line array indented at least to the same level as the start of the statement.">
         <![CDATA[
 if ($condition) {
     $a =
@@ -14,9 +14,14 @@ if ($condition) {
         2,
     ];
 }
+
+$b = <em>[</em>
+    1,
+    2,
+];
         ]]>
         </code>
-        <code title="Invalid: Opening square bracket/parenthesis of a multi-line array not indented at least to the same level as the start of the statement.">
+        <code title="Invalid: Opening brace of a multi-line array not indented at least to the same level as the start of the statement.">
         <![CDATA[
 if ($condition) {
     $a =
@@ -30,36 +35,36 @@ if ($condition) {
     </code_comparison>
     <standard>
     <![CDATA[
-    The elements of an array must be indented four spaces beyond the indentation level of the opening square bracket/parenthesis.
+    The first line of each array element must be indented exactly four spaces more than the start of the statement.
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: Elements of an array indented four spaces beyond the indentation level of the opening square bracket/parenthesis.">
+        <code title="Valid: First line of each array element indented exactly four spaces more than the start of the statement.">
         <![CDATA[
 $a = array(
-<em>    1</em>,
-<em>    2</em>,
-<em>    3</em>,
+<em>    </em>1,
+<em>    </em>2,
+<em>    </em>3,
 );
         ]]>
         </code>
-        <code title="Invalid: Elements of an array not indented four spaces beyond the indentation level of the opening square bracket/parenthesis.">
+        <code title="Invalid: First line of each array element not indented exactly four spaces more than the start of the statement.">
         <![CDATA[
 $a = array(
-<em>  1</em>,
+<em>  </em>1,
     2,
-<em>        3</em>,
+<em>        </em>3,
 );
         ]]>
         </code>
     </code_comparison>
     <standard>
     <![CDATA[
-    There must be a newline before the array closing square bracket/parenthesis.
+    There must be a newline before the array closing brace.
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: Newline before the array closing square bracket/parenthesis.">
+        <code title="Valid: Newline before the array closing brace.">
         <![CDATA[
 $a = [
     1,
@@ -67,7 +72,7 @@ $a = [
 ]</em>;
         ]]>
         </code>
-        <code title="Invalid: No newline before the array closing square bracket/parenthesis.">
+        <code title="Invalid: No newline before the array closing brace.">
         <![CDATA[
 $a = [
     1,
@@ -77,11 +82,11 @@ $a = [
     </code_comparison>
     <standard>
     <![CDATA[
-    The closing square bracket/parenthesis must be indented four spaces less than the array elements.
+    The closing brace must be on the same level of indentation as the start of the statement containing the array opener.
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: Closing square bracket/parenthesis indented four spaces less than the array elements.">
+        <code title="Valid: Closing brace on the same level of indentation as the start of the statement containing the array opener.">
         <![CDATA[
 $a = array(
     1,
@@ -89,7 +94,7 @@ $a = array(
 <em>)</em>;
         ]]>
         </code>
-        <code title="Invalid: Closing square bracket/parenthesis not indented four spaces less than the array elements.">
+        <code title="Invalid: Closing brace not on the same level of indentation as the start of the statement containing the array opener.">
         <![CDATA[
 $a = array(
     1,

From da6c78d54c1e717f6fc701b69d4bdcdaedafd1d8 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Thu, 31 Oct 2024 13:11:11 +0100
Subject: [PATCH 4/4] Generic/ArrayIndent: tweak the text of the docs some more

---
 .../Docs/Arrays/ArrayIndentStandard.xml       | 33 ++++++++++---------
 1 file changed, 17 insertions(+), 16 deletions(-)

diff --git a/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
index ffb6e35c36..0312a70f15 100644
--- a/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
+++ b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
@@ -5,8 +5,13 @@
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: Opening brace of a multi-line array indented at least to the same level as the start of the statement.">
+        <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>
@@ -15,13 +20,9 @@ if ($condition) {
     ];
 }
 
-$b = <em>[</em>
-    1,
-    2,
-];
         ]]>
         </code>
-        <code title="Invalid: Opening brace of a multi-line array not indented at least to the same level as the start of the statement.">
+        <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 =
@@ -35,11 +36,11 @@ if ($condition) {
     </code_comparison>
     <standard>
     <![CDATA[
-    The first line of each array element must be indented exactly four spaces more than the start of the statement.
+    Each array element must be indented exactly four spaces from the start of the statement.
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: First line of each array element indented exactly four spaces more than the start of the statement.">
+        <code title="Valid: Each array element is indented by exactly four spaces.">
         <![CDATA[
 $a = array(
 <em>    </em>1,
@@ -48,11 +49,11 @@ $a = array(
 );
         ]]>
         </code>
-        <code title="Invalid: First line of each array element not indented exactly four spaces more than the start of the statement.">
+        <code title="Invalid: Array elements not indented by four spaces.">
         <![CDATA[
 $a = array(
 <em>  </em>1,
-    2,
+<em>     </em>2,
 <em>        </em>3,
 );
         ]]>
@@ -60,11 +61,11 @@ $a = array(
     </code_comparison>
     <standard>
     <![CDATA[
-    There must be a newline before the array closing brace.
+    The array closing brace must be on a new line.
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: Newline before the array closing brace.">
+        <code title="Valid: Array closing brace on its own line.">
         <![CDATA[
 $a = [
     1,
@@ -72,7 +73,7 @@ $a = [
 ]</em>;
         ]]>
         </code>
-        <code title="Invalid: No newline before the array closing brace.">
+        <code title="Invalid: Array closing brace not on its own line.">
         <![CDATA[
 $a = [
     1,
@@ -82,11 +83,11 @@ $a = [
     </code_comparison>
     <standard>
     <![CDATA[
-    The closing brace must be on the same level of indentation as the start of the statement containing the array opener.
+    The closing brace must be aligned with the start of the statement containing the array opener.
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: Closing brace on the same level of indentation as the start of the statement containing the array opener.">
+        <code title="Valid: Closing brace aligned with the start of the statement containing the array opener.">
         <![CDATA[
 $a = array(
     1,
@@ -94,7 +95,7 @@ $a = array(
 <em>)</em>;
         ]]>
         </code>
-        <code title="Invalid: Closing brace not on the same level of indentation as the start of the statement containing the array opener.">
+        <code title="Invalid: Closing brace not aligned with the start of the statement containing the array opener.">
         <![CDATA[
 $a = array(
     1,