docs

docs/mdsource/pure.include.md

@@ -0,0 +1,8 @@
+Verify uses the [PureAttribute](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.contracts.pureattribute) to mark methods where the result of the method is expected to be used. For example awaiting the call to `Verify()`.
+Rider and ReSharper can be configured to treat the return value of these methods as an error.
+Add the following to the `.editorconfig` file:
+
+```
+[*.cs]
+resharper_return_value_of_pure_method_is_not_used_highlighting = error
+```

docs/mdsource/text-file-settings.include.md

@@ -22,6 +22,7 @@ eg add the following to `.gitattributes`
 *.verified.json text eol=lf working-tree-encoding=UTF-8
 ```
 
+
 #### EditorConfig settings
 
 If modifying text verified/received files in an editor, it is desirable for the editor to respect the above conventions. For [EditorConfig](https://editorconfig.org/) enabled the following can be used:
@@ -38,5 +39,4 @@ tab_width = unset
 trim_trailing_whitespace = false
 ```
 
-
 **Note that the above are suggested for subset of text extension. Add others as required based on the text file types being verified.**

docs/mdsource/wiz/Linux_Rider_Cli_Expecto_AppVeyor.source.md

@@ -47,6 +47,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Expecto_AzureDevOps.source.md

@@ -47,6 +47,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Expecto_GitHubActions.source.md

@@ -47,6 +47,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Expecto_None.source.md

@@ -47,6 +47,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Fixie_AppVeyor.source.md

@@ -46,6 +46,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Fixie_AzureDevOps.source.md

@@ -46,6 +46,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Fixie_GitHubActions.source.md

@@ -46,6 +46,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Fixie_None.source.md

@@ -46,6 +46,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_MSTest_AppVeyor.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_MSTest_AzureDevOps.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_MSTest_GitHubActions.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_MSTest_None.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_NUnit_AppVeyor.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_NUnit_AzureDevOps.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_NUnit_GitHubActions.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_NUnit_None.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_TUnit_AppVeyor.source.md

@@ -46,6 +46,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_TUnit_AzureDevOps.source.md

@@ -46,6 +46,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_TUnit_GitHubActions.source.md

@@ -46,6 +46,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_TUnit_None.source.md

@@ -46,6 +46,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_XunitV3_AppVeyor.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_XunitV3_AzureDevOps.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_XunitV3_GitHubActions.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_XunitV3_None.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Xunit_AppVeyor.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Xunit_AzureDevOps.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Xunit_GitHubActions.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Cli_Xunit_None.source.md

@@ -48,6 +48,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Gui_Expecto_AppVeyor.source.md

@@ -45,6 +45,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Gui_Expecto_AzureDevOps.source.md

@@ -45,6 +45,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Gui_Expecto_GitHubActions.source.md

@@ -45,6 +45,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Gui_Expecto_None.source.md

@@ -45,6 +45,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Gui_Fixie_AppVeyor.source.md

@@ -45,6 +45,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received

docs/mdsource/wiz/Linux_Rider_Gui_Fixie_AzureDevOps.source.md

@@ -45,6 +45,10 @@ This is optional, but recommended.
 
 include: rider-resharper-orphaned-process
 
+
+## Treat "return value of pure method is not used" as error
+
+include: pure
 ## DiffPlex
 
 The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received