Commit build changes [ci skip]

MathieuBuisson · Jul 4, 2017 · a4a9392 · a4a9392
1 parent e29072a
commit a4a9392
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/PSCodeHealth/PSCodeHealth.psd1 b/PSCodeHealth/PSCodeHealth.psd1
@@ -12,7 +12,7 @@
 RootModule = '.\PSCodeHealth.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.1.148'
+ModuleVersion = '0.1.149'
 
 # ID used to uniquely identify this module
 GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'

diff --git a/docs/PublicFunctions/Test-PSCodeHealthCompliance.md b/docs/PublicFunctions/Test-PSCodeHealthCompliance.md
@@ -62,6 +62,16 @@ In the case of TestCoverage, this metric exists in both PerFunctionMetrics and O
 
 ### -------------------------- EXAMPLE 5 --------------------------
 ```
+Test-PSCodeHealthCompliance -HealthReport $MyProjectHealthReport -Function 'Get-Something'
+```
+
+Evaluates the compliance results specifically for the function Get-Something.
+Because this is the compliance of a specific function, only the per function metrics are evaluated.
+
+If the value of the Function parameter doesn't match any function name in the HealthReport the parameter validation will fail and state the set of possible values.
+
+### -------------------------- EXAMPLE 6 --------------------------
+```
 Invoke-PSCodeHealth | Test-PSCodeHealthCompliance -Summary
 ```