Update documentation for Today and to date ranges

Author: ThomazFB

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/Time Range/Range Data Generation/AnalyticsHubMonthToDateRangeData.swift

@@ -4,9 +4,20 @@ import Foundation
 /// until the current date and the previous one, starting from the first day of the previous month
 /// until the same day of the previous month. E. g.
 ///
-/// Today: 31 Jul 2022
+/// Today: 20 Jul 2022
+///
 /// Current range: Jul 1 until Jul 31, 2022
-/// Previous range: Jun 1 until Jun 30, 2022
+/// Formatted current range for UI: Jul 1 until Jul 20, 2022
+/// 
+/// Previous range: Jun 1 until Jun 20, 2022
+/// Formatted previous range for UI: Jun 1 until Jun 20, 2022
+///
+/// The reason why there's a difference between the current range and the formatted current range
+/// is due to the My Store rule that creates the end date far in the future for each tab instead of using today's date.
+/// This behavior covers any time zone gap between the app and the store, always fetching as much data in “the future” as possible.
+///
+/// For data consistency, the Analytics Hub should follow the same for this range,
+/// but only for the current one, the previous should remain using the today's date as the reference for the end date. 
 ///
 struct AnalyticsHubMonthToDateRangeData: AnalyticsHubTimeRangeData {
     let currentDateStart: Date?

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/Time Range/Range Data Generation/AnalyticsHubQuarterToDateRangeData.swift

@@ -5,8 +5,19 @@ import Foundation
 /// until the same relative day of the previous quarter. E. g.
 ///
 /// Today: 15 Feb 2022
-/// Current range: Jan 1 until Feb 15, 2022
+///
+/// Current range: Jan 1 until Mar 31, 2022
+/// Formatted current range for UI: Jan 1 until Feb 15, 2022
+///
 /// Previous range: Oct 1 until Nov 15, 2021
+/// Formatted previous range for UI: Jan 1 until Nov 15, 2021
+///
+/// The reason why there's a difference between the current range and the formatted current range
+/// is due to the My Store rule that creates the end date far in the future for each tab instead of using today's date.
+/// This behavior covers any time zone gap between the app and the store, always fetching as much data in “the future” as possible.
+///
+/// For data consistency, the Analytics Hub should follow the same for this range,
+/// but only for the current one, the previous should remain using the today's date as the reference for the end date.
 ///
 struct AnalyticsHubQuarterToDateRangeData: AnalyticsHubTimeRangeData {
     let currentDateStart: Date?

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/Time Range/Range Data Generation/AnalyticsHubTodayRangeData.swift

@@ -4,9 +4,20 @@ import Foundation
 /// until the same day in the current time and the previous one, starting from the first second of
 /// yesterday until the same time of that day. E. g.
 ///
-/// Today: 29 Jul 2022
-/// Current range: Jul 29 until Jul 29, 2022
-/// Previous range: Jul 28 until Jul 28, 2022
+/// Today: 29 Jul 11:30 AM 2022
+///
+/// Current range: Jul 29 00:00 until Jul 29 23:59, 2022
+/// Formatted current range for UI: Jul 29, 2022
+///
+/// Previous range: Jul 28 00:00 until Jul 28 11:30 AM, 2022
+/// Formatted previous range for UI: Jul 28, 2022
+///
+/// The reason why there's a difference between the current range and the formatted current range
+/// is due to the My Store rule that creates the end date far in the future for each tab instead of using today's date.
+/// This behavior covers any time zone gap between the app and the store, always fetching as much data in “the future” as possible.
+///
+/// For data consistency, the Analytics Hub should follow the same for this range,
+/// but only for the current one, the previous should remain using the today's date as the reference for the end date. 
 ///
 struct AnalyticsHubTodayRangeData: AnalyticsHubTimeRangeData {
     let currentDateStart: Date?

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/Time Range/Range Data Generation/AnalyticsHubWeekToDateRangeData.swift

@@ -5,8 +5,19 @@ import Foundation
 /// until the same day of that week. E. g.
 ///
 /// Today: 29 Jul 2022
-/// Current range: Jul 25 until Jul 29, 2022
+///
+/// Current range: Jul 25 until Jul 31, 2022
+/// Formatted current range for UI: Jul 25 until Jul 29, 2022
+/// 
 /// Previous range: Jul 18 until Jul 22, 2022
+/// Formatted previous range for UI: Jul 18 until Jul 22, 2022
+///
+/// The reason why there's a difference between the current range and the formatted current range
+/// is due to the My Store rule that creates the end date far in the future for each tab instead of using today's date.
+/// This behavior covers any time zone gap between the app and the store, always fetching as much data in “the future” as possible.
+///
+/// For data consistency, the Analytics Hub should follow the same for this range,
+/// but only for the current one, the previous should remain using the today's date as the reference for the end date. 
 ///
 struct AnalyticsHubWeekToDateRangeData: AnalyticsHubTimeRangeData {
     let currentDateStart: Date?

WooCommerce/Classes/ViewRelated/Dashboard/Analytics Hub/Time Range/Range Data Generation/AnalyticsHubYearToDateRangeData.swift

@@ -5,8 +5,19 @@ import Foundation
 /// until the same day on the in that year. E. g.
 ///
 /// Today: 1 Jul 2022
-/// Current range: Jan 1 until Jul 1, 2022
-/// Previous range: Jan 1 until Jul 1, 2022
+///
+/// Current range: Jan 1 until Dec 31, 2022
+/// Formatted current range for UI: Jan 1 until Jul 1, 2022
+/// 
+/// Previous range: Jan 1 until Jul 1, 2021
+/// Formatted previous range for UI: Jan 1 until Jul 1, 2021
+///
+/// The reason why there's a difference between the current range and the formatted current range
+/// is due to the My Store rule that creates the end date far in the future for each tab instead of using today's date.
+/// This behavior covers any time zone gap between the app and the store, always fetching as much data in “the future” as possible.
+///
+/// For data consistency, the Analytics Hub should follow the same for this range,
+/// but only for the current one, the previous should remain using the today's date as the reference for the end date. 
 ///
 struct AnalyticsHubYearToDateRangeData: AnalyticsHubTimeRangeData {
     let currentDateStart: Date?