Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Improve documentation of NUnit1032 #807

Merged
merged 3 commits into from
Dec 14, 2024
Merged

doc: Improve documentation of NUnit1032 #807

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c000f7
doc: Improve documentation of NUnit1032
mikkelbu Dec 14, 2024
47c7a20
chore: Specify that the configuration is a list of names
mikkelbu Dec 14, 2024
1f8f774
fix: Correct linting
mikkelbu Dec 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions documentation/NUnit1032.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,18 @@ 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`. The configuration accepts a
list of method names - separated by either comma, semicolon, or space. I.e. to add `Quit` and `Exit` to the list add
the following line.
mikkelbu marked this conversation as resolved.
Show resolved Hide resolved

```ini
dotnet_diagnostic.NUnit1032.additional_dispose_methods = Quit, Exit
```

<!-- start generated config severity -->
## Configure severity

Expand Down
Loading