From 1238c8a3653e355082a73f86fed7b15aa251bf1b Mon Sep 17 00:00:00 2001
From: Jon McPartland <jon@bigbite.net>
Date: Mon, 5 Feb 2024 17:54:31 +0000
Subject: [PATCH 1/5] Docs: add documentation for
 Squiz.WhiteSpace.SuperfluousWhitespace

---
 .../SuperfluousWhitespaceStandard.xml         | 66 +++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml

diff --git a/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
new file mode 100644
index 0000000000..238ec12475
--- /dev/null
+++ b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
@@ -0,0 +1,66 @@
+<documentation title="Superfluous Whitespace">
+    <standard>
+    <![CDATA[
+    There should be no extra whitespace at the start of a file.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: No whitespace preceding first content in file.">
+        <![CDATA[<?php
+echo 'hi';
+]]>
+        </code>
+        <code title="Invalid: Whitespace used before content in file.">
+        <![CDATA[
+        <em></em>
+<?php
+echo 'hi';
+]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    There should be no trailing whitespace at the end of lines.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: No whitespace found at end of line.">
+        <![CDATA[
+echo 'hello';
+]]>
+        </code>
+        <code title="Invalid: Whitespace found at end of line.">
+        <![CDATA[
+echo 'hello';<em>   </em>
+]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    There should be no more than one consecutive blank newline in functions.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Functions do not contain multiple empty lines in a row.">
+        <![CDATA[
+function myFunction()
+{
+    echo 'code here';
+
+    echo 'code here';
+}
+]]>
+        </code>
+        <code title="Invalid: Functions contain multiple empty lines in a row.">
+        <![CDATA[
+function myFunction()
+{
+    echo 'code here';
+    <em>
+
+    </em>echo 'code here';
+}
+]]>
+        </code>
+    </code_comparison>
+</documentation>

From aa088bdfc35a53864c4c8e563f87baa101287cd1 Mon Sep 17 00:00:00 2001
From: Jon McPartland <jon@bigbite.net>
Date: Fri, 23 Feb 2024 16:07:41 +0000
Subject: [PATCH 2/5] Docs: improve documentation for
 Squiz.WhiteSpace.SuperfluousWhitespace

- Add code comparison for a missed error code (EOF)
- Fixup CDATA indentation
- Clarify wording in code examples
---
 .../SuperfluousWhitespaceStandard.xml         | 57 +++++++++++++++----
 1 file changed, 45 insertions(+), 12 deletions(-)

diff --git a/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
index 238ec12475..8963c8af5d 100644
--- a/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
+++ b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
@@ -1,21 +1,21 @@
 <documentation title="Superfluous Whitespace">
     <standard>
     <![CDATA[
-    There should be no extra whitespace at the start of a file.
+    There should be no superfluous whitespace at the start of a file.
     ]]>
     </standard>
     <code_comparison>
         <code title="Valid: No whitespace preceding first content in file.">
         <![CDATA[<?php
-echo 'hi';
-]]>
+echo 'opening PHP tag at start of file';
+        ]]>
         </code>
         <code title="Invalid: Whitespace used before content in file.">
         <![CDATA[
-        <em></em>
+<em>        </em>
 <?php
-echo 'hi';
-]]>
+echo 'whitespace before opening PHP tag';
+        ]]>
         </code>
     </code_comparison>
     <standard>
@@ -26,13 +26,13 @@ echo 'hi';
     <code_comparison>
         <code title="Valid: No whitespace found at end of line.">
         <![CDATA[
-echo 'hello';
-]]>
+echo 'semicolon followed by new linechar';
+        ]]>
         </code>
         <code title="Invalid: Whitespace found at end of line.">
         <![CDATA[
-echo 'hello';<em>   </em>
-]]>
+echo 'trailing spaces after semicolon';<em>   </em>
+        ]]>
         </code>
     </code_comparison>
     <standard>
@@ -49,7 +49,7 @@ function myFunction()
 
     echo 'code here';
 }
-]]>
+        ]]>
         </code>
         <code title="Invalid: Functions contain multiple empty lines in a row.">
         <![CDATA[
@@ -60,7 +60,40 @@ function myFunction()
 
     </em>echo 'code here';
 }
-]]>
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    There should be no superfluous whitespace at the end of a file.
+    A single final newline is allowed. A closing PHP tag is optional and ignored.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: A single newline appears after the last content in the file.">
+        <![CDATA[
+function myFunction()
+{
+    echo 'closing curly brace, 1 newline';
+    echo 'optional closing PHP tag';
+    echo 'then EOF';
+}<em>
+</em>
+?>
+        ]]>
+        </code>
+        <code title="Invalid: Multiple newlines appear after the last content in the file.">
+        <![CDATA[
+function myFunction()
+{
+    echo 'closing curly brace, 2 newlines';
+    echo 'optional closing PHP tag';
+    echo 'then EOF';
+}<em>
+
+</em>
+?>
+        ]]>
         </code>
     </code_comparison>
 </documentation>

From fe18bcb78a11ac59a2504ab7aeebbef4a1182b08 Mon Sep 17 00:00:00 2001
From: Jon McPartland <jon@bigbite.net>
Date: Mon, 26 Feb 2024 12:15:21 +0000
Subject: [PATCH 3/5] Docs: fix typo in Squiz.WhiteSpace.SuperfluousWhitespace
 code example

---
 .../Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml     | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
index 8963c8af5d..1224e645f4 100644
--- a/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
+++ b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
@@ -26,7 +26,7 @@ echo 'whitespace before opening PHP tag';
     <code_comparison>
         <code title="Valid: No whitespace found at end of line.">
         <![CDATA[
-echo 'semicolon followed by new linechar';
+echo 'semicolon followed by new line char';
         ]]>
         </code>
         <code title="Invalid: Whitespace found at end of line.">

From a584db2644f17a70f36dc1f5e4cb651e8ab63985 Mon Sep 17 00:00:00 2001
From: Jon McPartland <jon@bigbite.net>
Date: Mon, 26 Feb 2024 12:16:16 +0000
Subject: [PATCH 4/5] Docs: rewrite incorrect code example for
 Squiz.WhiteSpace.SuperfluousWhitespace.EndFile

---
 .../SuperfluousWhitespaceStandard.xml         | 27 +++++++++----------
 1 file changed, 13 insertions(+), 14 deletions(-)

diff --git a/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
index 1224e645f4..997d78f966 100644
--- a/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
+++ b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
@@ -65,34 +65,33 @@ function myFunction()
     </code_comparison>
     <standard>
     <![CDATA[
-    There should be no superfluous whitespace at the end of a file.
-    A single final newline is allowed. A closing PHP tag is optional and ignored.
+    There should be no superfluous whitespace after the final closing PHP tag in a file.
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: A single newline appears after the last content in the file.">
+        <code title="Valid: A single new line appears after the last content in the file.">
         <![CDATA[
 function myFunction()
 {
-    echo 'closing curly brace, 1 newline';
-    echo 'optional closing PHP tag';
-    echo 'then EOF';
-}<em>
+    echo 'Closing PHP tag, then';
+    echo 'Single new line char, then EOF';
+}
+
+?><em>
 </em>
-?>
         ]]>
         </code>
-        <code title="Invalid: Multiple newlines appear after the last content in the file.">
+        <code title="Invalid: Multiple new lines appear after the last content in the file.">
         <![CDATA[
 function myFunction()
 {
-    echo 'closing curly brace, 2 newlines';
-    echo 'optional closing PHP tag';
-    echo 'then EOF';
-}<em>
+    echo 'Closing PHP tag, then';
+    echo 'Multiple new line chars, then EOF';
+}
+
+?><em>
 
 </em>
-?>
         ]]>
         </code>
     </code_comparison>

From c593d615c5a0a9f09a924280fa4befb8e4df8b4b Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Tue, 27 Feb 2024 03:12:03 +0100
Subject: [PATCH 5/5] Squiz/SuperfluousWhitespace: tiny tweak

---
 .../Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml     | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
index 997d78f966..b4ad03d0b4 100644
--- a/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
+++ b/src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
@@ -37,7 +37,7 @@ echo 'trailing spaces after semicolon';<em>   </em>
     </code_comparison>
     <standard>
     <![CDATA[
-    There should be no more than one consecutive blank newline in functions.
+    There should be no consecutive blank lines in functions.
     ]]>
     </standard>
     <code_comparison>