Skip to content

Commit

Permalink
Address review comments. Docstring cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
chipkent committed Dec 15, 2023
1 parent 40d2a6c commit 1f5d28d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* <p>
* A calendar is associated with a specific time zone.
* <p>
* 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 {
Expand Down Expand Up @@ -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.
*
* <p>
* 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
Expand All @@ -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.
*
* <p>
* 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
Expand Down Expand Up @@ -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.
*
* <p>
* 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
Expand All @@ -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.
*
* <p>
* 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.
*
* <p>
* 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}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>
* 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.
*
Expand Down

0 comments on commit 1f5d28d

Please sign in to comment.