Skip to content

Commit 9ef0fbb

Browse files
committed
Document warning suppressions via rule set files
Fixes #1629
1 parent da92b89 commit 9ef0fbb

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

documentation/SA1652.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,20 @@ errors over time.
3434
To fix a violation of this rule, enable the XML documentation file as part of the project output.
3535

3636
**Note:** In some cases, enabling XML documentation output will produce a large number of warnings CS1573 and/or CS1591
37-
to be reported. To improve the ability of teams to resolve SA1652 before CS1573 and/or CS1591, consider editing the
38-
project file to include the following property group.
37+
to be reported. To improve the ability of teams to resolve SA1652 before CS1573 and/or CS1591, consider disabling these
38+
warnings by one of the following methods.
39+
40+
### Suppression via rule set files
41+
42+
CS1573 and CS1591 are most easily suppressed by editing the rule set file. The severity of these rules may be set to
43+
**Hidden** or **None** to hide them from the build output.
44+
45+
### Suppression via the project file
46+
47+
For users who sometimes build their project with older versions of C# (which do not support rule set files), these
48+
warnings may be suppressed by configuring the `<NoWarn>` element in the project file. One easy way to configure both the
49+
documentation output (which corrects SA1652) and the suppressions for CS1573 and CS1591 is to add the following property
50+
group to the project file.
3951

4052
```xml
4153
<PropertyGroup>

0 commit comments

Comments
 (0)