Corrections for trailing spaces

* Extension was added in new machine shift but defaults to "trim on save" which is bad

Author: smaillet

README.md

@@ -12,3 +12,9 @@ of multiple small libraries that didn't warrant a distinct repository.
 | [Ubiquity.NET.Runtime.Utils](https://ubiquitydotnet.github.io/Ubiquity.NET.Utils/runtime-utils/index.html) | This library contains common support for DSL runtime and language implementers |
 | [Ubiquity.NET.SourceGenerator.Test.Utils](https://ubiquitydotnet.github.io/Ubiquity.NET.Utils/src-gen-test-utils/index.html) | This library contains extensions and helpers for testing source generators |
 | [Ubiquity.NET.SrcGeneration](https://ubiquitydotnet.github.io/Ubiquity.NET.Utils/SrcGeneration/index.html) | This library contains extensions and helpers for implementing source generators |
+
+>[!IMPORTANT]
+> When editing code in this repository make certain that any extensions or tooling that
+> automatically removes trailing whitespace is disabled. It is fine to highlight such cases
+> and most of the time remove any. However, there are some tests where a trailing whitespace
+> is required and a critical part of the tests.

src/Ubiquity.NET.SrcGeneration.UT/CSharp/TextWriterExtensionsTests.cs

@@ -170,12 +170,14 @@ This is a remarks line
             This is another discrete line. The preceding duplicate blank is removed.
             """;
 
-            // NOTE: Literal strings requires a blank line to indicate a line terminator.
+            // NOTE: Literal strings require a blank line to indicate a line terminator.
             //       Otherwise, the compiler generates a string without a terminating new line!
+            //       Also note, that there is an intentional trailing whitespace to indicate a
+            //       non-empty line for this test.
             const string expected = """
             /// <remarks>
             /// This is a remarks line
-            ///
+            /// 
             /// This is another discrete line. The preceding duplicate blank is removed.
             /// </remarks>
 
@@ -226,11 +228,13 @@ This is another discrete line. The preceding duplicate blank is removed.
 
             // NOTE: Literal strings requires a blank line to indicate a line terminator.
             //       Otherwise, the compiler generates a string without a terminating new line!
+            //       Also note, that there is an intentional trailing whitespace to indicate a
+            //       non-empty line for this test.
             const string expected = """
             /// <summary>description of this API</summary>
             /// <remarks>
             /// This is a remarks line
-            ///
+            /// 
             /// This is another discrete line. The preceding duplicate blank is removed.
             /// </remarks>