docs

VerifyTests · Dec 14, 2024 · bed7993 · bed7993
1 parent 67fb82f
commit bed7993
Show file tree

Hide file tree

Showing 14 changed files with 142 additions and 72 deletions.
diff --git a/docs/combinations.md b/docs/combinations.md
@@ -329,7 +329,7 @@ Combination serialization can be customized using a Converter.
 
 Inherit from `CombinationResultsConverter` and override the desired members.
 
-The below sample override `BuildPropertyName` to customize the property name. It bypasses the default implementation and hence does not pad columns or use VerifierSettings.GetNameForParameter for key conversion.
+The below sample override `BuildPropertyName` to customize the property name. It bypasses the default implementation and hence does not pad columns or use `VerifierSettings.GetNameForParameter` for key conversion.
 
 <!-- snippet: CombinationSample_CustomSerializationConverter -->
 <a id='snippet-CombinationSample_CustomSerializationConverter'></a>

diff --git a/docs/mdsource/combinations.source.md b/docs/mdsource/combinations.source.md
@@ -70,7 +70,7 @@ Combination serialization can be customized using a Converter.
 
 Inherit from `CombinationResultsConverter` and override the desired members.
 
-The below sample override `BuildPropertyName` to customize the property name. It bypasses the default implementation and hence does not pad columns or use VerifierSettings.GetNameForParameter for key conversion.
+The below sample override `BuildPropertyName` to customize the property name. It bypasses the default implementation and hence does not pad columns or use `VerifierSettings.GetNameForParameter` for key conversion.
 
 snippet: CombinationSample_CustomSerializationConverter
 

diff --git a/docs/mdsource/name-for-parameters.include.md b/docs/mdsource/name-for-parameters.include.md
@@ -0,0 +1 @@
+For unknown types the parameter information cannot be derived. In these scenarios `ToString()` is used. To use custom text for a parameter use `NameForParameter()`.
diff --git a/docs/mdsource/parameterised-nunit.source.md b/docs/mdsource/parameterised-nunit.source.md
@@ -31,6 +31,13 @@ Produces:
  * `TestFixtureSourceUsage.Test_arg1=Value2_arg2=2.verified.txt`
 
 
+### Unknown parameter types
+
+include: name-for-parameters
+
+snippet: NameForParametersNunit
+
+
 ## Overriding text used for parameters
 
 include: override-parameters-text

diff --git a/docs/mdsource/parameterised-xunitv2.source.md b/docs/mdsource/parameterised-xunitv2.source.md
@@ -41,23 +41,21 @@ Given the following MemberData
 snippet: MemberDataGetDataXunit
 
 
-#### Instance 
+#### Instance
 
 snippet: MemberDataInstanceXunit
 
 
-#### Fluent 
+#### Fluent
 
 snippet: MemberDataFluentXunit
 
 
-### Complex MemberData
-
-xUnit only exposes parameter information for certain types. For unknown types the information cannot be retrieved from the xUnit context, and instead the text for the parameter value needs to be explicitly specified. This is done by calling `NameForParameter()`.
+### Unknown parameter types
 
-snippet: ComplexMemberDataXunit
+include: name-for-parameters
 
-`VerifierSettings.NameForParameter()` is required since the parameter type has no `ToString()` override that can be used for deriving the name of the `.verified.` file.
+snippet: NameForParametersXunit
 
 
 ## Overriding text used for parameters

diff --git a/docs/mdsource/parameterised-xunitv3.source.md b/docs/mdsource/parameterised-xunitv3.source.md
@@ -31,13 +31,11 @@ snippet: InlineDataXunitV3
 snippet: MemberDataXunitV3
 
 
-### Complex MemberData
+### Unknown parameter types
 
-xUnit only exposes parameter information for certain types. For unknown types the information cannot be retrieved from the xUnit context, and instead the text for the parameter value needs to be explicitly specified. This is done by calling `NameForParameter()`.
+include: name-for-parameters
 
-snippet: xunitV3ComplexMemberData
-
-`VerifierSettings.NameForParameter()` is required since the parameter type has no `ToString()` override that can be used for deriving the name of the `.verified.` file.
+snippet: NameForParametersXunitV3
 
 
 ## Overriding text used for parameters

diff --git a/docs/parameterised-nunit.md b/docs/parameterised-nunit.md
@@ -90,6 +90,42 @@ Produces:
  * `TestFixtureSourceUsage.Test_arg1=Value2_arg2=2.verified.txt`
 
 
+### Unknown parameter types
+
+For unknown types the parameter information cannot be derived. In these scenarios `ToString()` is used. To use custom text for a parameter use `NameForParameter()`.<!-- singleLineInclude: name-for-parameters. path: /docs/mdsource/name-for-parameters.include.md -->
+
+<!-- snippet: NameForParametersNunit -->
+<a id='snippet-NameForParametersNunit'></a>
+```cs
+public class ComplexParametersSample
+{
+    [ModuleInitializer]
+    public static void Initialize() =>
+        VerifierSettings.NameForParameter<ComplexData>(_ => _.Value);
+
+    [TestCaseSource(nameof(GetData))]
+    public Task ComplexTestCaseSource(ComplexData arg) =>
+        Verify(arg);
+
+    public static IEnumerable<object[]> GetData()
+    {
+        yield return
+        [
+            new ComplexData("Value1")
+        ];
+        yield return
+        [
+            new ComplexData("Value2")
+        ];
+    }
+
+    public record ComplexData(string Value);
+}
+```
+<sup><a href='/src/Verify.NUnit.Tests/Snippets/ComplexParametersSample.cs#L1-L28' title='Snippet source file'>snippet source</a> | <a href='#snippet-NameForParametersNunit' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+
 ## Overriding text used for parameters
 
 `UseTextForParameters()` can be used to override the substitution text used for the `{Parameters}` part of the file convention.<!-- include: override-parameters-text. path: /docs/mdsource/override-parameters-text.include.md -->

diff --git a/docs/parameterised-xunitv2.md b/docs/parameterised-xunitv2.md
@@ -116,7 +116,7 @@ public static IEnumerable<object[]> GetData()
 <!-- endSnippet -->
 
 
-#### Instance 
+#### Instance
 
 <!-- snippet: MemberDataInstanceXunit -->
 <a id='snippet-MemberDataInstanceXunit'></a>
@@ -134,7 +134,7 @@ public Task MemberDataUsage(string arg)
 <!-- endSnippet -->
 
 
-#### Fluent 
+#### Fluent
 
 <!-- snippet: MemberDataFluentXunit -->
 <a id='snippet-MemberDataFluentXunit'></a>
@@ -149,12 +149,12 @@ public Task MemberDataUsageFluent(string arg) =>
 <!-- endSnippet -->
 
 
-### Complex MemberData
+### Unknown parameter types
 
-xUnit only exposes parameter information for certain types. For unknown types the information cannot be retrieved from the xUnit context, and instead the text for the parameter value needs to be explicitly specified. This is done by calling `NameForParameter()`.
+For unknown types the parameter information cannot be derived. In these scenarios `ToString()` is used. To use custom text for a parameter use `NameForParameter()`.<!-- singleLineInclude: name-for-parameters. path: /docs/mdsource/name-for-parameters.include.md -->
 
-<!-- snippet: ComplexMemberDataXunit -->
-<a id='snippet-ComplexMemberDataXunit'></a>
+<!-- snippet: NameForParametersXunit -->
+<a id='snippet-NameForParametersXunit'></a>
 ```cs
 public class ComplexParametersSample
 {
@@ -166,7 +166,7 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberData))]
+    [MemberData(nameof(GetData))]
     public Task ComplexMemberData(ComplexData arg)
     {
         var settings = new VerifySettings();
@@ -175,13 +175,13 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberData))]
+    [MemberData(nameof(GetData))]
     public Task ComplexMemberDataFluent(ComplexData arg) =>
         Verify(arg)
             .UseParameters(arg);
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberData))]
+    [MemberData(nameof(GetData))]
     public Task ComplexMemberNullableData(ComplexData arg)
     {
         var settings = new VerifySettings();
@@ -190,12 +190,12 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberData))]
+    [MemberData(nameof(GetData))]
     public Task ComplexMemberNullableDataFluent(ComplexData arg) =>
         Verify(arg)
             .UseParameters(arg);
 
-    public static IEnumerable<object[]> GetComplexMemberData()
+    public static IEnumerable<object[]> GetData()
     {
         yield return
         [
@@ -210,7 +210,7 @@ public class ComplexParametersSample
     public record ComplexData(string Value);
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberStructData))]
+    [MemberData(nameof(GetStructData))]
     public Task ComplexMemberStructData(ComplexStructData arg)
     {
         var settings = new VerifySettings();
@@ -219,13 +219,13 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberStructData))]
+    [MemberData(nameof(GetStructData))]
     public Task ComplexMemberStructDataFluent(ComplexStructData arg) =>
         Verify(arg)
             .UseParameters(arg);
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberStructData))]
+    [MemberData(nameof(GetStructData))]
     public Task ComplexMemberNullableStructData(ComplexStructData arg)
     {
         var settings = new VerifySettings();
@@ -234,12 +234,12 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberStructData))]
+    [MemberData(nameof(GetStructData))]
     public Task ComplexMemberNullableStructDataFluent(ComplexStructData arg) =>
         Verify(arg)
             .UseParameters(arg);
 
-    public static IEnumerable<object[]> GetComplexMemberStructData()
+    public static IEnumerable<object[]> GetStructData()
     {
         yield return [new ComplexStructData("Value1")];
         yield return [new ComplexStructData("Value2")];
@@ -248,11 +248,9 @@ public class ComplexParametersSample
     public record ComplexStructData(string Value);
 }
 ```
-<sup><a href='/src/Verify.Xunit.Tests/Snippets/ComplexParametersSample.cs#L1-L95' title='Snippet source file'>snippet source</a> | <a href='#snippet-ComplexMemberDataXunit' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Xunit.Tests/Snippets/ComplexParametersSample.cs#L1-L95' title='Snippet source file'>snippet source</a> | <a href='#snippet-NameForParametersXunit' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
-`VerifierSettings.NameForParameter()` is required since the parameter type has no `ToString()` override that can be used for deriving the name of the `.verified.` file.
-
 
 ## Overriding text used for parameters
 

diff --git a/docs/parameterised-xunitv3.md b/docs/parameterised-xunitv3.md
@@ -96,12 +96,12 @@ public static IEnumerable<object[]> GetData()
 <!-- endSnippet -->
 
 
-### Complex MemberData
+### Unknown parameter types
 
-xUnit only exposes parameter information for certain types. For unknown types the information cannot be retrieved from the xUnit context, and instead the text for the parameter value needs to be explicitly specified. This is done by calling `NameForParameter()`.
+For unknown types the parameter information cannot be derived. In these scenarios `ToString()` is used. To use custom text for a parameter use `NameForParameter()`.<!-- singleLineInclude: name-for-parameters. path: /docs/mdsource/name-for-parameters.include.md -->
 
-<!-- snippet: xunitV3ComplexMemberData -->
-<a id='snippet-xunitV3ComplexMemberData'></a>
+<!-- snippet: NameForParametersXunitV3 -->
+<a id='snippet-NameForParametersXunitV3'></a>
 ```cs
 public class ComplexParametersSample
 {
@@ -113,7 +113,7 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberData))]
+    [MemberData(nameof(GetData))]
     public Task ComplexMemberData(ComplexData arg)
     {
         var settings = new VerifySettings();
@@ -122,13 +122,13 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberData))]
+    [MemberData(nameof(GetData))]
     public Task ComplexMemberDataFluent(ComplexData arg) =>
         Verify(arg)
             .UseParameters(arg);
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberData))]
+    [MemberData(nameof(GetData))]
     public Task ComplexMemberNullableData(ComplexData arg)
     {
         var settings = new VerifySettings();
@@ -137,12 +137,12 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberData))]
+    [MemberData(nameof(GetData))]
     public Task ComplexMemberNullableDataFluent(ComplexData arg) =>
         Verify(arg)
             .UseParameters(arg);
 
-    public static IEnumerable<object[]> GetComplexMemberData()
+    public static IEnumerable<object[]> GetData()
     {
         yield return
         [
@@ -157,7 +157,7 @@ public class ComplexParametersSample
     public record ComplexData(string Value);
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberStructData))]
+    [MemberData(nameof(GetStructData))]
     public Task ComplexMemberStructData(ComplexStructData arg)
     {
         var settings = new VerifySettings();
@@ -166,13 +166,13 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberStructData))]
+    [MemberData(nameof(GetStructData))]
     public Task ComplexMemberStructDataFluent(ComplexStructData arg) =>
         Verify(arg)
             .UseParameters(arg);
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberStructData))]
+    [MemberData(nameof(GetStructData))]
     public Task ComplexMemberNullableStructData(ComplexStructData arg)
     {
         var settings = new VerifySettings();
@@ -181,12 +181,12 @@ public class ComplexParametersSample
     }
 
     [Theory]
-    [MemberData(nameof(GetComplexMemberStructData))]
+    [MemberData(nameof(GetStructData))]
     public Task ComplexMemberNullableStructDataFluent(ComplexStructData arg) =>
         Verify(arg)
             .UseParameters(arg);
 
-    public static IEnumerable<object[]> GetComplexMemberStructData()
+    public static IEnumerable<object[]> GetStructData()
     {
         yield return [new ComplexStructData("Value1")];
         yield return [new ComplexStructData("Value2")];
@@ -195,11 +195,9 @@ public class ComplexParametersSample
     public record ComplexStructData(string Value);
 }
 ```
-<sup><a href='/src/Verify.XunitV3.Tests/Snippets/ComplexParametersSample.cs#L1-L95' title='Snippet source file'>snippet source</a> | <a href='#snippet-xunitV3ComplexMemberData' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.XunitV3.Tests/Snippets/ComplexParametersSample.cs#L1-L95' title='Snippet source file'>snippet source</a> | <a href='#snippet-NameForParametersXunitV3' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
-`VerifierSettings.NameForParameter()` is required since the parameter type has no `ToString()` override that can be used for deriving the name of the `.verified.` file.
-
 
 ## Overriding text used for parameters
 

diff --git a/...Unit.Tests/Snippets/ComplexParametersSample.ComplexTestCaseSource_arg=Value1.verified.txt b/...Unit.Tests/Snippets/ComplexParametersSample.ComplexTestCaseSource_arg=Value1.verified.txt
@@ -0,0 +1,3 @@
+{
+  Value: Value1
+}
diff --git a/...Unit.Tests/Snippets/ComplexParametersSample.ComplexTestCaseSource_arg=Value2.verified.txt b/...Unit.Tests/Snippets/ComplexParametersSample.ComplexTestCaseSource_arg=Value2.verified.txt
@@ -0,0 +1,3 @@
+{
+  Value: Value2
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		For unknown types the parameter information cannot be derived. In these scenarios `ToString()` is used. To use custom text for a parameter use `NameForParameter()`.