diff --git a/CHANGELOG.md b/CHANGELOG.md index 03e9d87..0234308 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Fixed +- `Get-ElapsedBusinessTime` did not return correct result when either the start date or end date were outside of business hours +- Added line breaks in between each line for all comment based help ## [0.1.2] - 2022-04-13 ### Fixed diff --git a/docs/Get-ElapsedBusinessTime.md b/docs/Get-ElapsedBusinessTime.md index 98ccc31..ac12065 100644 --- a/docs/Get-ElapsedBusinessTime.md +++ b/docs/Get-ElapsedBusinessTime.md @@ -20,10 +20,15 @@ Get-ElapsedBusinessTime [-StartDate] [-EndDate] [[-StartHo ## DESCRIPTION Get the elapsed time between two dates, where the time measured is only inbetween "business hours". + This is helpful to measure the amount of time past from a start datetime, to an end datetime, while only considering "business hours". + What constitutes "business hours" in terms of day of the week, or calendar date, including working hours, is arbitrary and completely customisable. + In other words, the default parameters dictate normal working days, which are Monday through Friday and 08:00 through 17:00. + You can also specify particular dates, or days of the week, to be regarded as non-working dates via the -NonWorkingDates and -NonWorkingDaysOfWeek parameters. + This function does consider both date and time while calculating the elapsed time. ## EXAMPLES @@ -116,6 +121,7 @@ Accept wildcard characters: False ### -StartHour The starting hour of a typical working day. The default starting hour is 08:00 (AM). + Note: this parameter is a datetime object is, however only the time is used for calculation. The date is ignored. @@ -134,6 +140,7 @@ Accept wildcard characters: False ### -FinishHour The final hour of a typical working day. The default final hour is 17:00. + Note: this parameter is a datetime object is, however only the time is used for calculation. The date is ignored. @@ -152,6 +159,7 @@ Accept wildcard characters: False ### -NonWorkingDaysOfWeek The days of the week, representated as strings e.g. 'Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday', which denotes non-working days of the week. + Days specified in this parameter will not be considered as working days. ```yaml @@ -168,6 +176,7 @@ Accept wildcard characters: False ### -NonWorkingDates An array of datetime objects which denote specific non-working dates. + Dates specified in this parameter will not be considered as working days. ```yaml diff --git a/docs/Get-WorkingDates.md b/docs/Get-WorkingDates.md index 2ef544c..9d07111 100644 --- a/docs/Get-WorkingDates.md +++ b/docs/Get-WorkingDates.md @@ -19,10 +19,15 @@ Get-WorkingDates [-StartDate] [-EndDate] [[-NonWorkingDays ## DESCRIPTION Return all the working dates between two given datetimes. + This is helpful to identify the specific dates between two dates which are considered to be "working day(s)". + What constitutes a "working day" in terms of day of the week, or calendar date, including working hours, is arbitrary and completely customisable. + In other words, the default parameters dictate normal working days, which are Monday through Friday. + You can also specify particular dates, or days of the week, to be regarded as non-working dates via the -NonWorkingDates and -NonWorkingDaysOfWeek parameters. + This function does not consider the time, only the date, when determining whether it is a working date or not. ## EXAMPLES @@ -107,6 +112,7 @@ Accept wildcard characters: False ### -NonWorkingDaysOfWeek The days of the week, representated as strings e.g. 'Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday', which denotes non-working days of the week. + Days specified in this parameter will not be considered as working days. ```yaml @@ -123,6 +129,7 @@ Accept wildcard characters: False ### -NonWorkingDates An array of datetime objects which denote specific non-working dates. + Dates specified in this parameter will not be considered as working days. ```yaml diff --git a/docs/Test-WorkingDay.md b/docs/Test-WorkingDay.md index 95dd00b..f55b731 100644 --- a/docs/Test-WorkingDay.md +++ b/docs/Test-WorkingDay.md @@ -19,9 +19,13 @@ Test-WorkingDay [-Date] [[-StartHour] ] [[-FinishHour]