task(COR-1948): Added comment for create-time-ticks function (#4986)

minvws · Feb 26, 2024 · c4c4a00 · c4c4a00
1 parent bf46d46
commit c4c4a00
Showing 1 changed file with 3 additions and 0 deletions.
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
@@ -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);