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

Tweak recommendation for assertions #43381

Merged
merged 1 commit into from
Apr 16, 2020
Merged

Tweak recommendation for assertions #43381

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 3 additions & 4 deletions docs/contributing/Nullable Annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,11 @@ struct SyntaxTrivia {
}
}
```
- **DO** use explicit validation such as `RoslynDebug.Assert` or
`Contract.ThrowIfNull` to validate state that is passed into the method if it
avoids the need for suppressions later in the method.
- **DO** use explicit validation such as `Debug.Assert` or
`Contract.ThrowIfNull` to capture internal program invariants.
```cs
void M1(SyntaxNode node) {
RoslynDebug.Assert(node.Parent is object);
Debug.Assert(node.Parent is object);
...
M2(node.Parent);
}
Expand Down