Skip to content

Commit 2b92d32

Browse files
committed
Include CS1712 in the documentation for SA0001
Closes #2630
1 parent aea1965 commit 2b92d32

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

documentation/SA0001.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,22 @@ errors over time.
3535

3636
To fix a violation of this rule, enable the XML documentation file as part of the project output.
3737

38-
**Note:** In some cases, enabling XML documentation output will produce a large number of warnings CS1573 and/or CS1591
39-
to be reported. To improve the ability of teams to resolve SA0001 before CS1573 and/or CS1591, consider disabling these
40-
warnings by one of the following methods.
38+
**Note:** In some cases, enabling XML documentation output will produce a large number of warnings CS1573, CS1591,
39+
and/or CS1712 to be reported. To improve the ability of teams to resolve SA0001 before CS1573, CS1591, and CS1712,
40+
consider disabling these warnings by one of the following methods.
4141

4242
### Suppression via rule set files
4343

44-
CS1573 and CS1591 are most easily suppressed by editing the rule set file. The severity of these rules may be set to
45-
**Hidden** or **None** to hide them from the build output.
44+
CS1573, CS1591, and CS1712 are most easily suppressed by editing the rule set file. The severity of these rules may be
45+
set to **Hidden** or **None** to hide them from the build output. When set to **Hidden**, code fixes for these
46+
diagnostics as a documentation aid will function normally, but the warnings themselves will be hidden from view.
4647

4748
### Suppression via the project file
4849

4950
For users who sometimes build their project with older versions of C# (which do not support rule set files), these
50-
warnings may be suppressed by configuring the `<NoWarn>` element in the project file. One easy way to configure both the
51-
documentation output (which corrects SA0001) and the suppressions for CS1573 and CS1591 is to add the following property
52-
group to the project file.
51+
warnings may be suppressed by configuring the `<NoWarn>` element in the project file. One easy way to configure both
52+
the documentation output (which corrects SA0001) and the suppressions for CS1573, CS1591, and CS1712 is to add the
53+
following property group to the project file.
5354

5455
```xml
5556
<PropertyGroup>
@@ -61,7 +62,7 @@ group to the project file.
6162
CS1591: Missing XML comment for publicly visible type or member 'Type_or_Member'
6263
-->
6364
<DocumentationFile>$(OutputPath)$(AssemblyName).xml</DocumentationFile>
64-
<NoWarn>$(NoWarn),1573,1591</NoWarn>
65+
<NoWarn>$(NoWarn),1573,1591,1712</NoWarn>
6566
</PropertyGroup>
6667
```
6768

0 commit comments

Comments
 (0)