Commit build changes [ci skip]

MathieuBuisson · Jul 5, 2017 · 698cecc · 698cecc
1 parent 1099279
commit 698cecc
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 5 deletions.
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.149'
+ModuleVersion = '0.1.150'
 
 # ID used to uniquely identify this module
 GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'

diff --git a/docs/InternalFunctions/New-PSCodeHealthComplianceResult.md b/docs/InternalFunctions/New-PSCodeHealthComplianceResult.md
@@ -7,6 +7,7 @@ Creates a new custom object and gives it the TypeName : 'PSCodeHealth.Compliance
 
 ```
 New-PSCodeHealthComplianceResult [-ComplianceRule] <PSObject> [-Value] <PSObject> [-Result] <String>
+ [[-FunctionName] <String>]
 ```
 
 ## DESCRIPTION
@@ -21,6 +22,13 @@ New-PSCodeHealthComplianceResult -ComplianceRule $Rule -Value 81.26 -Result Warn
 
 Returns new custom object of the type PSCodeHealth.Compliance.Result.
 
+### -------------------------- EXAMPLE 2 --------------------------
+```
+New-PSCodeHealthComplianceResult -ComplianceRule $Rule -Value 81.26 -Result Warning -FunctionName 'Get-Something'
+```
+
+Returns new custom object of the type PSCodeHealth.Compliance.FunctionResult for the function 'Get-Something'.
+
 ## PARAMETERS
 
 ### -ComplianceRule
@@ -68,11 +76,28 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -FunctionName
+To get compliance results for a specific function.
+
+If this parameter is specified, this creates a PSCodeHealth.Compliance.FunctionResult object, instead of PSCodeHealth.Compliance.Result.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: 4
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ## INPUTS
 
 ## OUTPUTS
 
-### PSCodeHealth.Compliance.Result
+### PSCodeHealth.Compliance.Result, PSCodeHealth.Compliance.FunctionResult
 
 ## NOTES
 

diff --git a/docs/PublicFunctions/Test-PSCodeHealthCompliance.md b/docs/PublicFunctions/Test-PSCodeHealthCompliance.md
@@ -62,13 +62,13 @@ In the case of TestCoverage, this metric exists in both PerFunctionMetrics and O
 
 ### -------------------------- EXAMPLE 5 --------------------------
 ```
-Test-PSCodeHealthCompliance -HealthReport $MyProjectHealthReport -Function 'Get-Something'
+Test-PSCodeHealthCompliance -HealthReport $MyProjectHealthReport -FunctionName '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.
+If the value of the FunctionName parameter doesn't match any function name in the HealthReport the parameter validation will fail and state the set of possible values.
 
 ### -------------------------- EXAMPLE 6 --------------------------
 ```
@@ -177,7 +177,7 @@ Accept wildcard characters: False
 
 ## OUTPUTS
 
-### PSCodeHealth.Compliance.Result, System.String
+### PSCodeHealth.Compliance.Result, PSCodeHealth.Compliance.FunctionResult, System.String
 
 ## NOTES