From c4c4a00348dce527a8f48d50526bdecf2f3bd806 Mon Sep 17 00:00:00 2001
From: M <120020483+VWSCoronaDashboard30@users.noreply.github.com>
Date: Mon, 26 Feb 2024 10:42:26 +0100
Subject: [PATCH] task(COR-1948): Added comment for create-time-ticks function
 (#4986)

---
 .../components/axes/logic/create-time-ticks.ts                 | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/packages/app/src/components/time-series-chart/components/axes/logic/create-time-ticks.ts b/packages/app/src/components/time-series-chart/components/axes/logic/create-time-ticks.ts
index 87ea09b8ce..f6d034cb76 100644
--- a/packages/app/src/components/time-series-chart/components/axes/logic/create-time-ticks.ts
+++ b/packages/app/src/components/time-series-chart/components/axes/logic/create-time-ticks.ts
@@ -44,6 +44,9 @@ function getDefault2ValuesForXAxis(startTick: number, endTick: number): TickInst
 export function createTimeTicksAllTimeFrame(startTick: number, endTick: number, ticksNumber: number, breakpoints: Breakpoints): TickInstance[] {
   /**
    * This method is only used for the `all` timeframe option.
+   * The function is not and won't be adjusted to cover all the edge cases available:
+   * e.g. having a very short period between the start and end date which results
+   * in only 1 or 2 january dates in between them.
    */
   const start = middleOfDayInSeconds(startTick);
   const end = middleOfDayInSeconds(endTick);