Skip to content

Commit 985175c

Browse files
author
Vadim Platonov
committed
readme: clarify caution
1 parent b6165d4 commit 985175c

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,11 +158,11 @@ Duration, on the other hand, represents a standard duration less than or equal
158158
to a single standard (24-hour) day.
159159

160160
### Caution
161-
162-
The current incarnation of the library is quite slow while calling the 2-3
163-
arity `zoned-date-time/offset-time/offset-date-time` constructors. If you need
164-
predictable latency on the first call, please warm the constructors you are
165-
going to use by using them in a 'warm-up phase', e.g.:
161+
The current incarnation of the library is relatively slow while calling the 2-3
162+
arity `zoned-date-time/offset-time/offset-date-time` constructors for the
163+
*first time* in a given Clojure runtime. If you need predictable latency at the
164+
time of the first call in your business logic, please warm the
165+
constructors you are going to use up by calling them beforehand, e.g.:
166166

167167
```clj
168168
(defn warm-up []
@@ -171,7 +171,9 @@ going to use by using them in a 'warm-up phase', e.g.:
171171
(zoned-date-time 2015))
172172
```
173173

174-
Only the types of the arguments matter, not the values!
174+
The "constructor" here refers to an arity of a function together with its type
175+
signature. For example, a `(zoned-date-time 2015)` and `(zoned-date-time (system-clock))`
176+
are different constructors.
175177

176178
### An appetizer
177179

0 commit comments

Comments
 (0)