Skip to content

Commit 43942d3

Browse files
committed
Fix docstrings
1 parent 5a5b7b0 commit 43942d3

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/luciolucio/holi.cljc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
[tick.core :as t]))
55

66
(defn add
7-
"Adds `n` of `unit` to `date` and returns a new date. Skips holidays in `calendars` when `unit` is `:business-days`.
7+
"Adds `n` of `unit` to `date` and returns a new date. Skips any holidays in `calendars` when `unit` is `:business-days`.
88
99
| Parameter | Description | Example |
1010
|-------------|----------------------------------------------------------------------------|---------------------------------------------------------|
1111
| `date` | An instance of `java.time.LocalDate` or `java.time.LocalDateTime` | `(LocalDate/of 2020 10 9)` |
1212
| `n` | An integer | `2`, `-1`, `0` |
1313
| `unit` | Unit of `n` | `:days` `:weeks` `:months` `:years` or `:business-days` |
14-
| `calendars` | One or more strings representing holiday calendars (`:business-days` only) | `" US "`, `" BR "` |
14+
| `calendars` | One or more strings representing holiday calendars (`:business-days` only) | `\" US \"`, `\" BR \"` |
1515
1616
**Notes**
1717
1. Types are preserved, i.e., passing a `LocalDate` in will return a `LocalDate`
@@ -42,7 +42,7 @@
4242
| Parameter | Description | Example |
4343
|------------|-------------------------------------------------------------------|----------------------------|
4444
| `date` | An instance of `java.time.LocalDate` or `java.time.LocalDateTime` | `(LocalDate/of 2020 10 9)` |
45-
| `calendar` | A string representing a holiday calendar | `" US "`, `" BR "` |"
45+
| `calendar` | A string representing a holiday calendar | `\" US \"`, `\" BR \"` |"
4646
[date calendar]
4747
(let [holidays (core/read-calendar calendar)]
4848
(core/is-date-in-list? date holidays)))
@@ -53,7 +53,7 @@
5353
| Parameter | Description | Example |
5454
|-------------|-------------------------------------------------------------------|----------------------------|
5555
| `date` | An instance of `java.time.LocalDate` or `java.time.LocalDateTime` | `(LocalDate/of 2020 10 9)` |
56-
| `calendars` | One or more strings representing holiday calendars | `" US "`, `" BR "` |"
56+
| `calendars` | One or more strings representing holiday calendars | `\" US \"`, `\" BR \"` |"
5757
[date & calendars]
5858
(let [non-business-days (core/read-calendars (set (conj calendars constants/WEEKEND-FILE-NAME)))]
5959
(core/is-date-in-list? date non-business-days)))
@@ -64,6 +64,6 @@
6464
| Parameter | Description | Example |
6565
|-------------|-------------------------------------------------------------------|----------------------------|
6666
| `date` | An instance of `java.time.LocalDate` or `java.time.LocalDateTime` | `(LocalDate/of 2020 10 9)` |
67-
| `calendars` | One or more strings representing holiday calendars | `" US "`, `" BR "` |"
67+
| `calendars` | One or more strings representing holiday calendars | `\" US \"`, `\" BR \"` |"
6868
[date & calendars]
6969
(not (apply non-business-day? date calendars)))

0 commit comments

Comments
 (0)