From 1f5d28d9ce1546008200c87c17feb9456d236ce4 Mon Sep 17 00:00:00 2001 From: Chip Kent Date: Fri, 15 Dec 2023 09:26:09 -0700 Subject: [PATCH] Address review comments. Docstring cleanup. --- .../java/io/deephaven/time/calendar/Calendar.java | 12 ++++++------ .../java/io/deephaven/time/calendar/CalendarDay.java | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/engine/time/src/main/java/io/deephaven/time/calendar/Calendar.java b/engine/time/src/main/java/io/deephaven/time/calendar/Calendar.java index 122865f2813..1cb624c171a 100644 --- a/engine/time/src/main/java/io/deephaven/time/calendar/Calendar.java +++ b/engine/time/src/main/java/io/deephaven/time/calendar/Calendar.java @@ -22,7 +22,7 @@ *

* A calendar is associated with a specific time zone. *

- * Date strings must be in a format that can be parsed by {@code DateTimeUtils#parseDate}. Methods that accept strings + * Date strings must be in a format that can be parsed by {@link DateTimeUtils#parseLocalDate(String)}. Methods that accept strings * can be slower than methods written explicitly for {@code Instant}, {@code ZonedDateTime}, or {@code LocalDate}. */ public class Calendar { @@ -209,7 +209,7 @@ public LocalDate plusDays(final String date, final int days) { /** * Adds a specified number of days to an input time. Adding negative days is equivalent to subtracting days. - * + *

* Day additions are not always 24 hours. The resultant time will have the same local time as the input time, as * determined by the calendar's time zone. This accounts for Daylight Savings Time. For example, 2023-11-05 has a * daylight savings time adjustment, so '2023-11-04T14:00 ET' plus 1 day will result in '2023-11-05T15:00 ET', which @@ -230,7 +230,7 @@ public Instant plusDays(final Instant time, final int days) { /** * Adds a specified number of days to an input time. Adding negative days is equivalent to subtracting days. - * + *

* Day additions are not always 24 hours. The resultant time will have the same local time as the input time, as * determined by the calendar's time zone. This accounts for Daylight Savings Time. For example, 2023-11-05 has a * daylight savings time adjustment, so '2023-11-04T14:00 ET' plus 1 day will result in '2023-11-05T15:00 ET', which @@ -290,7 +290,7 @@ public LocalDate minusDays(final String date, final int days) { /** * Subtracts a specified number of days to an input time. Subtracting negative days is equivalent to adding days. - * + *

* Day subtractions are not always 24 hours. The resultant time will have the same local time as the input time, as * determined by the calendar's time zone. This accounts for Daylight Savings Time. For example, 2023-11-05 has a * daylight savings time adjustment, so '2023-11-04T14:00 ET' plus 1 day will result in '2023-11-05T15:00 ET', which @@ -311,12 +311,12 @@ public Instant minusDays(final Instant time, final int days) { /** * Subtracts a specified number of days to an input time. Subtracting negative days is equivalent to adding days. - * + *

* Day subtractions are not always 24 hours. The resultant time will have the same local time as the input time, as * determined by the calendar's time zone. This accounts for Daylight Savings Time. For example, 2023-11-05 has a * daylight savings time adjustment, so '2023-11-04T14:00 ET' plus 1 day will result in '2023-11-05T15:00 ET', which * is a 25-hour difference. - * + *

* The resultant time will have the same time zone as the calendar. This could be different than the time zone of * the input {@link ZonedDateTime}. * diff --git a/engine/time/src/main/java/io/deephaven/time/calendar/CalendarDay.java b/engine/time/src/main/java/io/deephaven/time/calendar/CalendarDay.java index 76dc16c237d..ba22de7bcef 100644 --- a/engine/time/src/main/java/io/deephaven/time/calendar/CalendarDay.java +++ b/engine/time/src/main/java/io/deephaven/time/calendar/CalendarDay.java @@ -17,7 +17,7 @@ /** * Schedule for a single calendar day. The schedule contains a list of business time ranges, which are the ranges of * time during which businesses are open. - * + *

* A business day may contain multiple business time ranges. For example, some financial exchanges have a morning and an * afternoon trading session. This would be represented by a business day with two business time ranges. *