docs

VerifyTests · Nov 27, 2023 · 53aac9d · 53aac9d
1 parent 8aae5a3
commit 53aac9d
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 12 deletions.
diff --git a/docs/serializer-settings.md b/docs/serializer-settings.md
@@ -79,9 +79,14 @@ The default encoding for snapshot files uses UTF-8 with byte order marks (BOM) e
 <!-- snippet: UseUtf8NoBom -->
 <a id='snippet-useutf8nobom'></a>
 ```cs
-VerifierSettings.UseUtf8NoBom();
+public static class ModuleInitializer
+{
+    [ModuleInitializer]
+    public static void Init() =>
+        VerifierSettings.UseUtf8NoBom();
+}
 ```
-<sup><a href='/src/StaticSettingsTests/EncodingTests.cs#L9-L11' title='Snippet source file'>snippet source</a> | <a href='#snippet-useutf8nobom' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/ModuleInitDocs/UseUtf8NoBom.cs#L3-L12' title='Snippet source file'>snippet source</a> | <a href='#snippet-useutf8nobom' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ## UseEncoding
@@ -91,13 +96,20 @@ To override the encoding used for snapshot files, replacing the default UTF-8 en
 <!-- snippet: UseEncoding -->
 <a id='snippet-useencoding'></a>
 ```cs
-var encoding = new UnicodeEncoding(
-    bigEndian: false,
-    byteOrderMark: true,
-    throwOnInvalidBytes: true);
-VerifierSettings.UseEncoding(encoding);
+public static class ModuleInitializer
+{
+    [ModuleInitializer]
+    public static void Init()
+    {
+        var encoding = new UnicodeEncoding(
+            bigEndian: false,
+            byteOrderMark: true,
+            throwOnInvalidBytes: true);
+        VerifierSettings.UseEncoding(encoding);
+    }
+}
 ```
-<sup><a href='/src/StaticSettingsTests/EncodingTests.cs#L27-L33' title='Snippet source file'>snippet source</a> | <a href='#snippet-useencoding' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/ModuleInitDocs/UseEncoding.cs#L3-L18' title='Snippet source file'>snippet source</a> | <a href='#snippet-useencoding' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ## Default settings

diff --git a/src/ModuleInitDocs/UseEncoding.cs b/src/ModuleInitDocs/UseEncoding.cs
@@ -0,0 +1,19 @@
+public class UseEncoding
+{
+    #region UseEncoding
+
+    public static class ModuleInitializer
+    {
+        [ModuleInitializer]
+        public static void Init()
+        {
+            var encoding = new UnicodeEncoding(
+                bigEndian: false,
+                byteOrderMark: true,
+                throwOnInvalidBytes: true);
+            VerifierSettings.UseEncoding(encoding);
+        }
+    }
+
+    #endregion
+}
diff --git a/src/ModuleInitDocs/UseUtf8NoBom.cs b/src/ModuleInitDocs/UseUtf8NoBom.cs
@@ -0,0 +1,13 @@
+public class UseUtf8NoBom
+{
+    #region UseUtf8NoBom
+
+    public static class ModuleInitializer
+    {
+        [ModuleInitializer]
+        public static void Init() =>
+            VerifierSettings.UseUtf8NoBom();
+    }
+
+    #endregion
+}
diff --git a/src/StaticSettingsTests/EncodingTests.cs b/src/StaticSettingsTests/EncodingTests.cs
@@ -6,9 +6,7 @@ public class EncodingTests :
     [Fact]
     public async Task UseUtf8NoBom()
     {
-        #region UseUtf8NoBom
         VerifierSettings.UseUtf8NoBom();
-        #endregion
 
         var file = CurrentFile.Relative($"EncodingTests.{nameof(UseUtf8NoBom)}.verified.txt");
         File.Delete(file);
@@ -24,13 +22,11 @@ public async Task UseUtf8NoBom()
     [Fact]
     public async Task Utf16()
     {
-        #region UseEncoding
         var encoding = new UnicodeEncoding(
             bigEndian: false,
             byteOrderMark: true,
             throwOnInvalidBytes: true);
         VerifierSettings.UseEncoding(encoding);
-        #endregion
 
         var file = CurrentFile.Relative($"EncodingTests.{nameof(Utf16)}.verified.txt");
         File.Delete(file);