Commit build changes [ci skip]

MathieuBuisson · May 8, 2017 · f001953 · f001953
1 parent f63d3d1
commit f001953
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 7 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.84'
+ModuleVersion = '0.1.85'
 
 # ID used to uniquely identify this module
 GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'

diff --git a/docs/Functions/Get-PSCodeHealthSetting.md b/docs/Functions/Get-PSCodeHealthSetting.md
@@ -10,7 +10,7 @@ Get-PSCodeHealthSetting [[-CustomSettingsPath] <String>] [[-SettingsGroup] <Stri
 ```
 
 ## DESCRIPTION
-Get the PSCodeHealth settings (metrics thresholds, etc...) which are currently in effect.
+Get the PSCodeHealth settings (metrics warning and fail thresholds, etc...) which are currently in effect.
 
 By default, all the settings are coming from the file PSCodeHealthSettings.json in the module root.
 
@@ -21,12 +21,29 @@ In this case, any setting specified in the custom settings file override the def
 
 ## EXAMPLES
 
-### Example 1
+### -------------------------- EXAMPLE 1 --------------------------
+```
+Get-PSCodeHealthSetting
+```
+
+Gets all the default PSCodeHealth settings (metrics warning and fail thresholds, etc...).
+
+### -------------------------- EXAMPLE 2 --------------------------
+```
+Get-PSCodeHealthSetting -CustomSettingsPath .\MySettings.json -SettingsGroup OverallHealthReportMetricsRules
+```
+
+Gets all PSCodeHealth settings (metrics warning and fail thresholds, etc...) in effect in the group 'OverallHealthReportMetricsRules'.
+
+This also output any setting overriding the defaults because they were specified in the file MySettings.json.
+
+### -------------------------- EXAMPLE 3 --------------------------
 ```
-PS C:\> {{ Add example code here }}
+Get-PSCodeHealthSetting -MetricName TestCoverage
 ```
 
-{{ Add example description here }}
+Gets the default settings (metrics warning and fail thresholds) in effect for the metric(s) named 'TestCoverage'.
+In this case, this metric exists in both FunctionHealthRecordMetricsRules and OverallHealthReportMetricsRules, so the TestCoverage settings from both groups will be output.
 
 ## PARAMETERS
 
@@ -50,7 +67,9 @@ Accept wildcard characters: False
 ### -SettingsGroup
 To filter the output settings to only the settings located in the specified group.
 
-There 2 settings group in PSCodeHealthSettings.json, so there are 2 possible values for this parameter : 'FunctionHealthRecordMetricsRules' and 'OverallHealthReportMetricsRules'.
+There are 2 settings groups in PSCodeHealthSettings.json, so there are 2 possible values for this parameter : 'FunctionHealthRecordMetricsRules' and 'OverallHealthReportMetricsRules'.
+
+Metrics in the FunctionHealthRecordMetricsRules group are generated for each individual function and metrics in the OverallHealthReportMetricsRules group are calculated for the entire file or folder specified in the 'Path' parameter of Invoke-PSCodeHealth.
 
 If not specified, all the settings are output.
 
@@ -67,7 +86,9 @@ Accept wildcard characters: False
 ```
 
 ### -MetricName
-{{Fill MetricName Description}}
+To filter the output settings to only the settings for the specified metric.
+
+There is a large number of metrics, so for convenience, all the possible values are available via tab completion.
 
 ```yaml
 Type: String