Skip to content

Commit df16dc2

Browse files
committed
[doc] Clarify *freeze-fallback* docstring
1 parent b02b375 commit df16dc2

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

src/taoensso/nippy.clj

+10-9
Original file line numberDiff line numberDiff line change
@@ -365,25 +365,26 @@
365365
;; For back compatibility (incl. Timbre's Carmine appender)
366366
(enc/defonce ^:dynamic ^:no-doc ^:deprecated *final-freeze-fallback* "Prefer `*freeze-fallback`." nil)
367367
(enc/defonce ^:dynamic *freeze-fallback*
368-
"Controls Nippy's behaviour when trying to freeze an item for which Nippy
369-
doesn't currently have a native freeze/thaw implementation.
368+
"Controls Nippy's behaviour when trying to freeze an object with a type for
369+
which Nippy doesn't currently have a native (protocol) implementation.
370370
371371
Possible values:
372372
373-
1. `nil` (no freeze-fallback, default)
373+
1. `nil` (no fallback, default)
374374
Tries the following in order:
375-
- Freeze with Java's `Serializable` interface if possible
376-
- Freeze with Clojure's reader if possible
375+
- Freeze with Java's `Serializable` interface if this seems possible
376+
- Freeze with Clojure's reader if this seems possible
377377
- Throw
378378
379379
2. `:write-unfreezable` keyword
380380
Tries the following in order:
381-
- Freeze with Java's `Serializable` interface if possible
382-
- Freeze with Clojure's reader if possible
381+
- Freeze with Java's `Serializable` interface if this seems possible
382+
- Freeze with Clojure's reader if this seems possible
383383
- Freeze a {:nippy/unfreezable {:type _}} placeholder value
384384
385-
3. [Advanced] Custom (fn [^java.io.DataOutput out item]) that must
386-
write exactly one value to the given `DataOutput` stream"
385+
3. [Advanced] Custom (fn [^java.io.DataOutput out obj]) that must
386+
write an appropriate object type id and payload to the given
387+
`DataOutput` stream."
387388

388389
nil)
389390

0 commit comments

Comments
 (0)