Merge pull request #2670 from sharwell/cs1712

Include CS1712 in the documentation for SA0001

Author: vweijsters

documentation/SA0001.md

@@ -35,21 +35,22 @@ errors over time.
 
 To fix a violation of this rule, enable the XML documentation file as part of the project output.
 
-**Note:** In some cases, enabling XML documentation output will produce a large number of warnings CS1573 and/or CS1591
-to be reported. To improve the ability of teams to resolve SA0001 before CS1573 and/or CS1591, consider disabling these
-warnings by one of the following methods.
+**Note:** In some cases, enabling XML documentation output will produce a large number of warnings CS1573, CS1591,
+and/or CS1712 to be reported. To improve the ability of teams to resolve SA0001 before CS1573, CS1591, and CS1712,
+consider disabling these warnings by one of the following methods.
 
 ### Suppression via rule set files
 
-CS1573 and CS1591 are most easily suppressed by editing the rule set file. The severity of these rules may be set to
-**Hidden** or **None** to hide them from the build output.
+CS1573, CS1591, and CS1712 are most easily suppressed by editing the rule set file. The severity of these rules may be
+set to **Hidden** or **None** to hide them from the build output. When set to **Hidden**, code fixes for these
+diagnostics as a documentation aid will function normally, but the warnings themselves will be hidden from view.
 
 ### Suppression via the project file
 
 For users who sometimes build their project with older versions of C# (which do not support rule set files), these
-warnings may be suppressed by configuring the `<NoWarn>` element in the project file. One easy way to configure both the
-documentation output (which corrects SA0001) and the suppressions for CS1573 and CS1591 is to add the following property
-group to the project file.
+warnings may be suppressed by configuring the `<NoWarn>` element in the project file. One easy way to configure both
+the documentation output (which corrects SA0001) and the suppressions for CS1573, CS1591, and CS1712 is to add the
+following property group to the project file.
 
 ```xml
 <PropertyGroup>
@@ -61,7 +62,7 @@ group to the project file.
     CS1591: Missing XML comment for publicly visible type or member 'Type_or_Member'
   -->
   <DocumentationFile>$(OutputPath)$(AssemblyName).xml</DocumentationFile>
-  <NoWarn>$(NoWarn),1573,1591</NoWarn>
+  <NoWarn>$(NoWarn),1573,1591,1712</NoWarn>
 </PropertyGroup>
 ```