doc: Improve documentation of NUnit1032

By including example of `additional_dispose_methods`.
nunit · Dec 14, 2024 · 3c000f7 · 3c000f7
1 parent f1329ad
commit 3c000f7
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/documentation/NUnit1032.md b/documentation/NUnit1032.md
@@ -60,6 +60,17 @@ dotnet_diagnostic.CA1001.severity = warning
 dotnet_diagnostic.CA2213.severity = warning
 ```
 
+## Extending the list of names of disposing methods
+
+The analyzer considers the following list of method names to be disposing: `Dispose`, `DisposeAsync`, `Close`, and
+`CloseAsync`. It is possible to add method names to this list by using the configuration
+`dotnet_diagnostic.NUnit1032.additional_dispose_methods` in the `.editorconfig`. I.e. to add `Quit` to the list add
+the following line.
+
+```ini
+dotnet_diagnostic.NUnit1032.additional_dispose_methods = Quit
+```
+
 <!-- start generated config severity -->
 ## Configure severity