Adding documentation about suppressing rule violations.

[splatteredbits]

No description provided.

[msftclas]

Hi @splatteredbits, I'm your friendly neighborhood Microsoft Pull Request Bot (You can call me MSBOT). Thanks for your contribution!

In order for us to evaluate and accept your PR, we ask that you sign a contribution license agreement. It's all electronic and will take just minutes. I promise there's no faxing. https://cla.microsoft.com.

TTYL, MSBOT;

[msftclas]

@splatteredbits, Thanks for signing the contribution license agreement so quickly! Actual humans will now validate the agreement and then evaluate the PR.

Thanks, MSBOT;

[quoctruong]

You can actually do this by simply decorating the class with the SuppressMessageAttribute (the scope is unnecessary in this case). A case where the use of scope is more meaningful is if you want to suppress a rule for all the classes within a script, then you can decorate the script with a SuppressMessageAttribute with the Scope as Class.

[splatteredbits]

So the scope reflects the kind of objects in the scope where the suppress
attribute is? So a scope of "function" would apply to all functions in the
scope of the attribute?

On Mon, Jul 13, 2015 at 3:40 PM, Quoc Truong notifications@github.com
wrote:

In README.md
#274 (comment)
:

• {

•    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSProvideDefaultParameterValue", "b")]
  

•    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSProvideDefaultParameterValue", "a")]
  

•    param([string]$a, [int]$b)
  

•    {
  

•    }
  

• }

+To suppress a rule for an entire function/script, decorate the param block of the script/function and set the SuppressMessageAttribute's Scope property to Function:
+

• [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSProvideCommentHelp", "", Scope="Function")]
• param(
• )

+You can also suppress a rule for an entire class using Class as the value of the Scope property:

You can actually do this by simply decorating the class with the
SuppressMessageAttribute (the scope is unnecessary in this case). A case
where the use of scope is more meaningful is if you want to suppress a rule
for all the classes within a script, then you can decorate the script with
a SuppressMessageAttribute with the Scope as Class.

—
Reply to this email directly or view it on GitHub
https://github.com/PowerShell/PSScriptAnalyzer/pull/274/files#r34520293.

[quoctruong]

Yes that is correct.

[splatteredbits]

Fixed.

On Mon, Jul 13, 2015 at 3:45 PM, Quoc Truong notifications@github.com
wrote:

In README.md
#274 (comment)
:

• {

•    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSProvideDefaultParameterValue", "b")]
  

•    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSProvideDefaultParameterValue", "a")]
  

•    param([string]$a, [int]$b)
  

•    {
  

•    }
  

• }

+To suppress a rule for an entire function/script, decorate the param block of the script/function and set the SuppressMessageAttribute's Scope property to Function:
+

• [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSProvideCommentHelp", "", Scope="Function")]
• param(
• )

+You can also suppress a rule for an entire class using Class as the value of the Scope property:

Yes that is correct.

—
Reply to this email directly or view it on GitHub
https://github.com/PowerShell/PSScriptAnalyzer/pull/274/files#r34520695.

[quoctruong]

This param is not attached to any function or script. You can look at https://github.com/PowerShell/PSScriptAnalyzer/blob/master/Tests/Engine/RuleSuppression.ps1 for an example of a param block of a function, script or class. Thanks!

[raghushantha]

Merging the PR. Changes look good.Thanks Aaron.