Commit build changes [ci skip]

MathieuBuisson · Jun 13, 2017 · 59a784a · 59a784a
1 parent 9257ca5
commit 59a784a
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 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.131'
+ModuleVersion = '0.1.132'
 
 # ID used to uniquely identify this module
 GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'

diff --git a/docs/InternalFunctions/Get-FunctionTestCoverage.md b/docs/InternalFunctions/Get-FunctionTestCoverage.md
@@ -1,7 +1,7 @@
 # Get-FunctionTestCoverage
 
 ## SYNOPSIS
-Gets the percentage of lines of code in the specified function that are tested by unit tests.
+Gets test coverage information for the specified function.
 
 ## SYNTAX
 
@@ -10,7 +10,11 @@ Get-FunctionTestCoverage [-FunctionDefinition] <FunctionDefinitionAst> [[-TestsP
 ```
 
 ## DESCRIPTION
-Gets the percentage of lines of code in the specified function definition that are tested (executed) by unit tests.
+Gets test coverage information for the specified function.
+This includes 2 pieces of information :  
+  - Code coverage percentage (lines of code that are exercised by unit tests)  
+  - Missed Commands (lines of codes or commands not being exercised by unit tests)  
+
 It uses Pester with its CodeCoverage parameter.
 
 ## EXAMPLES
@@ -20,7 +24,7 @@ It uses Pester with its CodeCoverage parameter.
 Get-FunctionTestCoverage -FunctionDefinition $MyFunctionAst -TestsPath $MyModule.ModuleBase
 ```
 
-Gets the percentage of lines of code in the function $MyFunctionAst that are tested by all tests found in the module's parent directory.
+Gets test coverage information for the function $MyFunctionAst given the tests found in the module's parent directory.
 
 ## PARAMETERS
 
@@ -60,7 +64,7 @@ Accept wildcard characters: False
 
 ## OUTPUTS
 
-### System.Double
+### PSCodeHealth.Function.TestCoverageInfo
 
 ## NOTES
 

diff --git a/docs/InternalFunctions/New-FunctionHealthRecord.md b/docs/InternalFunctions/New-FunctionHealthRecord.md
@@ -6,7 +6,7 @@ Creates a new custom object and gives it the TypeName : 'PSCodeHealth.Function.H
 ## SYNTAX
 
 ```
-New-FunctionHealthRecord [-FunctionDefinition] <FunctionDefinitionAst> [-FunctionTestCoverage] <Double>
+New-FunctionHealthRecord [-FunctionDefinition] <FunctionDefinitionAst> [-FunctionTestCoverage] <PSObject>
 ```
 
 ## DESCRIPTION
@@ -42,13 +42,13 @@ Accept wildcard characters: False
 To specify the percentage of lines of code in the specified function that are tested by unit tests.
 
 ```yaml
-Type: Double
+Type: PSObject
 Parameter Sets: (All)
 Aliases: 
 
 Required: True
 Position: 2
-Default value: 0
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```