From 958da99f123787ba7563204e76d01ef36ed7d934 Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Wed, 8 May 2024 09:27:07 +0200 Subject: [PATCH] v1.0.0-beta10 (2024-05-08) --- index.clj.html | 2 +- index.cljs.html | 2 +- index.html | 2 +- taoensso.telemere.cljs.html | 17 +++++++++-------- taoensso.telemere.html | 17 +++++++++-------- taoensso.telemere.open-telemetry.html | 2 +- taoensso.telemere.postal.html | 2 +- taoensso.telemere.slack.html | 2 +- taoensso.telemere.sockets.html | 2 +- taoensso.telemere.streams.html | 2 +- taoensso.telemere.timbre.cljs.html | 2 +- taoensso.telemere.timbre.html | 2 +- taoensso.telemere.tools-logging.html | 2 +- taoensso.telemere.utils.cljs.html | 17 +++++++++-------- taoensso.telemere.utils.html | 17 +++++++++-------- 15 files changed, 47 insertions(+), 43 deletions(-) diff --git a/index.clj.html b/index.clj.html index 80d5c6b..882eca2 100644 --- a/index.clj.html +++ b/index.clj.html @@ -1,6 +1,6 @@ -Telemere 1.0.0-beta9

Namespaces

Telemere 1.0.0-beta9

Released under the Eclipse Public License - v 1.0

Structured telemetry library for Clojure/Script.

Installation

To install, add the following dependency to your project or build file:

[com.taoensso/telemere "1.0.0-beta9"]

Namespaces

taoensso.telemere

Structured telemetry for Clojure/Script applications.

Public variables and functions:

taoensso.telemere.open-telemetry

OpenTelemetry handler using `opentelemetry-java`,
+Telemere 1.0.0-beta10
Namespaces
Telemere 1.0.0-beta10
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta10"]
Namespaces
taoensso.telemere
Structured telemetry for Clojure/Script applications.
Public variables and functions:
taoensso.telemere.open-telemetry
OpenTelemetry handler using `opentelemetry-java`,
 Ref. <https://github.com/open-telemetry/opentelemetry-java>.
Public variables and functions:
taoensso.telemere.postal
Email handler using `postal`,
 Ref. <https://github.com/drewr/postal>.
Public variables and functions:
taoensso.telemere.slack
Slack handler using `clj-slack`,
 Ref. <https://github.com/julienXX/clj-slack>
Public variables and functions:
taoensso.telemere.sockets
Basic TCP/UDP socket handlers.
Public variables and functions:
taoensso.telemere.streams
Intake support for standard stream/s -> Telemere.
Public variables and functions:
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere.
diff --git a/index.cljs.html b/index.cljs.html
index dc13540..5b8c68d 100644
--- a/index.cljs.html
+++ b/index.cljs.html
@@ -1,4 +1,4 @@
 
-Telemere 1.0.0-beta9
Namespaces
Telemere 1.0.0-beta9
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta9"]
Namespaces
taoensso.telemere
Structured telemetry for Clojure/Script applications.
Public variables and functions:
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere.
+Telemere 1.0.0-beta10
Namespaces
Telemere 1.0.0-beta10
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta10"]
Namespaces
taoensso.telemere
Structured telemetry for Clojure/Script applications.
Public variables and functions:
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere.
 Intended to help ease migration from Timbre to Telemere.
Public variables and functions:
taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc.
Public variables and functions:

\ No newline at end of file
diff --git a/index.html b/index.html
index 4c6c856..7673bff 100644
--- a/index.html
+++ b/index.html
@@ -1,3 +1,3 @@
 
-Telemere 1.0.0-beta9
Platforms
Telemere 1.0.0-beta9
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta9"]
Platforms
This project includes code for multiple platforms, please choose a platform to view its documentation:

\ No newline at end of file
+Telemere 1.0.0-beta10
Platforms
Telemere 1.0.0-beta10
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta10"]
Platforms
This project includes code for multiple platforms, please choose a platform to view its documentation:

\ No newline at end of file
diff --git a/taoensso.telemere.cljs.html b/taoensso.telemere.cljs.html
index 9af24dd..5915ea3 100644
--- a/taoensso.telemere.cljs.html
+++ b/taoensso.telemere.cljs.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere documentation
Namespaces
Public Vars
taoensso.telemere
Structured telemetry for Clojure/Script applications.
+taoensso.telemere documentation
Namespaces
Public Vars
taoensso.telemere
Structured telemetry for Clojure/Script applications.
 
 See the GitHub page (esp. Wiki) for info on motivation and design:
   <https://www.taoensso.com/telemere>
*ctx*
dynamic
clj
cljs
Dynamic context: arbitrary user-level state attached as `:ctx` to all signals.
@@ -608,25 +608,26 @@ Useful for conditionally splicing in extra message content, etc.:
   (log!          [(when <cond> (msg-splice ["Username:" "Steve"]))])
 
     %> {:msg_ "Username: Steve"}
newline
clj
cljs
added in Encore v3.68.0 (2023-09-25)
Single system newline
-
pr-signal-fn
clj
cljs
(pr-signal-fn pr-fn)(pr-signal-fn pr-fn {:keys [incl-thread? incl-kvs? incl-newline? prep-fn], :or {incl-newline? true, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
+
pr-signal-fn
clj
cljs
(pr-signal-fn)(pr-signal-fn {:keys [incl-thread? incl-kvs? incl-newline? pr-fn prep-fn], :or {incl-newline? true, pr-fn :edn, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
 Returns a (fn pr [signal]) that:
   - Takes a Telemere signal (map).
   - Returns a machine-readable (minified) signal string.
 
 Options:
-  `pr-fn`          - ∈ #{<unary-fn> :edn :json (Cljs only)}
+  `:pr-fn`         - ∈ #{<unary-fn> :edn (default) :json (Cljs only)}
   `:incl-thread?`  - Include signal `:thread` info?      (default false)
   `:incl-kvs?`     - Include signal `:kvs`    info?      (default false)
   `:incl-newline?` - Include terminating system newline? (default true)
 
 Examples:
-  (pr-signal-fn :edn  {<opts>})
-  (pr-signal-fn :json {<opts>}) ; Cljs only
+  (pr-signal-fn {:pr-fn :edn  ...}) ; Outputs edn
+  (pr-signal-fn {:pr-fn :json ...}) ; Outputs JSON (Cljs only)
+
+  To output JSON for Clj, you must provide an appropriate `:pr-fn`.
+  `jsonista` is one good option, Ref. <https://github.com/metosin/jsonista>:
 
-  ;; To output JSON for Clj, you must provide an appropriate `pr-fn`.
-  ;; `jsonista` is a good option, Ref. <https://github.com/metosin/jsonista>:
     (require '[jsonista.core :as jsonista])
-    (pr-signal-fn jsonista/write-value-as-string {<opts>})
+    (pr-signal-fn {:pr-fn jsonista/write-value-as-string ...})
 
 See also `format-signal-fn` for human-readable output.
rate-limiter
clj
cljs
(rate-limiter spec)(rate-limiter opts spec)
Takes a spec of form
   [           [<n-max-reqs> <msecs-window>] ...] or
diff --git a/taoensso.telemere.html b/taoensso.telemere.html
index 2ec91af..5b55505 100644
--- a/taoensso.telemere.html
+++ b/taoensso.telemere.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere documentation
Namespaces
Public Vars
taoensso.telemere
Structured telemetry for Clojure/Script applications.
+taoensso.telemere documentation
Namespaces
Public Vars
taoensso.telemere
Structured telemetry for Clojure/Script applications.
 
 See the GitHub page (esp. Wiki) for info on motivation and design:
   <https://www.taoensso.com/telemere>
*ctx*
dynamic
clj
cljs
Dynamic context: arbitrary user-level state attached as `:ctx` to all signals.
@@ -736,25 +736,26 @@ Useful for conditionally splicing in extra message content, etc.:
   (log!          [(when <cond> (msg-splice ["Username:" "Steve"]))])
 
     %> {:msg_ "Username: Steve"}
newline
clj
cljs
added in Encore v3.68.0 (2023-09-25)
Single system newline
-
pr-signal-fn
clj
cljs
(pr-signal-fn pr-fn)(pr-signal-fn pr-fn {:keys [incl-thread? incl-kvs? incl-newline? prep-fn], :or {incl-newline? true, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
+
pr-signal-fn
clj
cljs
(pr-signal-fn)(pr-signal-fn {:keys [incl-thread? incl-kvs? incl-newline? pr-fn prep-fn], :or {incl-newline? true, pr-fn :edn, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
 Returns a (fn pr [signal]) that:
   - Takes a Telemere signal (map).
   - Returns a machine-readable (minified) signal string.
 
 Options:
-  `pr-fn`          - ∈ #{<unary-fn> :edn :json (Cljs only)}
+  `:pr-fn`         - ∈ #{<unary-fn> :edn (default) :json (Cljs only)}
   `:incl-thread?`  - Include signal `:thread` info?      (default false)
   `:incl-kvs?`     - Include signal `:kvs`    info?      (default false)
   `:incl-newline?` - Include terminating system newline? (default true)
 
 Examples:
-  (pr-signal-fn :edn  {<opts>})
-  (pr-signal-fn :json {<opts>}) ; Cljs only
+  (pr-signal-fn {:pr-fn :edn  ...}) ; Outputs edn
+  (pr-signal-fn {:pr-fn :json ...}) ; Outputs JSON (Cljs only)
+
+  To output JSON for Clj, you must provide an appropriate `:pr-fn`.
+  `jsonista` is one good option, Ref. <https://github.com/metosin/jsonista>:
 
-  ;; To output JSON for Clj, you must provide an appropriate `pr-fn`.
-  ;; `jsonista` is a good option, Ref. <https://github.com/metosin/jsonista>:
     (require '[jsonista.core :as jsonista])
-    (pr-signal-fn jsonista/write-value-as-string {<opts>})
+    (pr-signal-fn {:pr-fn jsonista/write-value-as-string ...})
 
 See also `format-signal-fn` for human-readable output.
rate-limiter
clj
cljs
(rate-limiter spec)(rate-limiter opts spec)
Takes a spec of form
   [           [<n-max-reqs> <msecs-window>] ...] or
diff --git a/taoensso.telemere.open-telemetry.html b/taoensso.telemere.open-telemetry.html
index e20adbc..89c7cb0 100644
--- a/taoensso.telemere.open-telemetry.html
+++ b/taoensso.telemere.open-telemetry.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.open-telemetry documentation
Namespaces
Public Vars
taoensso.telemere.open-telemetry
OpenTelemetry handler using `opentelemetry-java`,
+taoensso.telemere.open-telemetry documentation
Namespaces
Public Vars
taoensso.telemere.open-telemetry
OpenTelemetry handler using `opentelemetry-java`,
 Ref. <https://github.com/open-telemetry/opentelemetry-java>.
default-logger-provider
clj
(default-logger-provider)
Experimental, subject to change. Feedback welcome!
 
 Returns `io.opentelemetry.api.logs.LoggerProvider` via:
diff --git a/taoensso.telemere.postal.html b/taoensso.telemere.postal.html
index 46a8b7b..fa23cd6 100644
--- a/taoensso.telemere.postal.html
+++ b/taoensso.telemere.postal.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.postal documentation
Namespaces
Public Vars
taoensso.telemere.postal
Email handler using `postal`,
+taoensso.telemere.postal documentation
Namespaces
Public Vars
taoensso.telemere.postal
Email handler using `postal`,
 Ref. <https://github.com/drewr/postal>.
default-dispatch-opts
clj
handler:postal
clj
(handler:postal {:keys [conn-opts msg-opts subject-fn body-fn], :or {subject-fn (signal-subject-fn), body-fn (utils/format-signal-fn)}})
Experimental, subject to change.
 
 Needs `postal`, Ref. <https://github.com/drewr/postal>.
diff --git a/taoensso.telemere.slack.html b/taoensso.telemere.slack.html
index 098e1ef..f3ebeaa 100644
--- a/taoensso.telemere.slack.html
+++ b/taoensso.telemere.slack.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.slack documentation
Namespaces
Public Vars
taoensso.telemere.slack
Slack handler using `clj-slack`,
+taoensso.telemere.slack documentation
Namespaces
Public Vars
taoensso.telemere.slack
Slack handler using `clj-slack`,
 Ref. <https://github.com/julienXX/clj-slack>
default-dispatch-opts
clj
handler:slack
clj
(handler:slack {:keys [conn-opts post-opts output-fn], :or {conn-opts {:api-url "https://slack.com/api", :token nil}, post-opts {:channel-id nil, :username nil}, output-fn (utils/format-signal-fn)}})
Experimental, subject to change.
 
 Needs `clj-slack`, Ref. <https://github.com/julienXX/clj-slack>.
diff --git a/taoensso.telemere.sockets.html b/taoensso.telemere.sockets.html
index 6de98f6..76eca6f 100644
--- a/taoensso.telemere.sockets.html
+++ b/taoensso.telemere.sockets.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.sockets documentation
Namespaces
Public Vars
taoensso.telemere.sockets
Basic TCP/UDP socket handlers.
+taoensso.telemere.sockets documentation
Namespaces
Public Vars
taoensso.telemere.sockets
Basic TCP/UDP socket handlers.
 
handler:tcp-socket
clj
(handler:tcp-socket {:keys [socket-opts output-fn], :or {output-fn (utils/format-signal-fn)}})
Experimental, subject to change.
 
 Returns a (fn handler [signal]) that:
diff --git a/taoensso.telemere.streams.html b/taoensso.telemere.streams.html
index b521d08..98bbdb8 100644
--- a/taoensso.telemere.streams.html
+++ b/taoensso.telemere.streams.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.streams documentation
Namespaces
Public Vars
taoensso.telemere.streams
Intake support for standard stream/s -> Telemere.
+taoensso.telemere.streams documentation
Namespaces
Public Vars
taoensso.telemere.streams
Intake support for standard stream/s -> Telemere.
 
check-err-intake
clj
(check-err-intake)
Returns {:keys [sending->telemere? telemere-receiving?]}.
 
check-out-intake
clj
(check-out-intake)
Returns {:keys [sending->telemere? telemere-receiving?]}.
 
streams->reset!
clj
(streams->reset!)
Experimental, subject to change.
diff --git a/taoensso.telemere.timbre.cljs.html b/taoensso.telemere.timbre.cljs.html
index b202776..752fc90 100644
--- a/taoensso.telemere.timbre.cljs.html
+++ b/taoensso.telemere.timbre.cljs.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.timbre documentation
Namespaces
Public Vars
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere.
+taoensso.telemere.timbre documentation
Namespaces
Public Vars
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere.
 Intended to help ease migration from Timbre to Telemere.
set-min-level!
clj
cljs
(set-min-level! min-level)
Prefer `telemere/set-min-level!`.
 
shutdown-appenders!
clj
cljs
(shutdown-appenders!)
Prefer `telemere/shut-down-handlers!`.
 

\ No newline at end of file
diff --git a/taoensso.telemere.timbre.html b/taoensso.telemere.timbre.html
index 93cd260..3f2a5c0 100644
--- a/taoensso.telemere.timbre.html
+++ b/taoensso.telemere.timbre.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.timbre documentation
Namespaces
Public Vars
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere.
+taoensso.telemere.timbre documentation
Namespaces
Public Vars
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere.
 Intended to help ease migration from Timbre to Telemere.
debug
macro
clj
(debug & args)
Prefer `telemere/log!`, etc.
 
debugf
macro
clj
(debugf & args)
Prefer `telemere/log!`, etc.
 
error
macro
clj
(error & args)
Prefer `telemere/log!`, etc.
diff --git a/taoensso.telemere.tools-logging.html b/taoensso.telemere.tools-logging.html
index e2c63f9..3b6f4cf 100644
--- a/taoensso.telemere.tools-logging.html
+++ b/taoensso.telemere.tools-logging.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.tools-logging documentation
Namespaces
Public Vars
taoensso.telemere.tools-logging
Intake support for `clojure.tools.logging` -> Telemere.
+taoensso.telemere.tools-logging documentation
Namespaces
Public Vars
taoensso.telemere.tools-logging
Intake support for `clojure.tools.logging` -> Telemere.
 Telemere will attempt to load this ns automatically when possible.
check-intake
clj
(check-intake)
Returns {:keys [present? sending->telemere? telemere-receiving?]}.
 
tools-logging->telemere!
clj
(tools-logging->telemere!)
Configures `clojure.tools.logging` to use Telemere as its logging implementation.
 
diff --git a/taoensso.telemere.utils.cljs.html b/taoensso.telemere.utils.cljs.html
index 2b711a3..e20887d 100644
--- a/taoensso.telemere.utils.cljs.html
+++ b/taoensso.telemere.utils.cljs.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.utils documentation
Namespaces
Public Vars
taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc.
+taoensso.telemere.utils documentation
Namespaces
Public Vars
taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc.
 
error-in-signal->maps
clj
cljs
(error-in-signal->maps signal)
Experimental, subject to change.
 Returns given signal with possible `:error` replaced by
 [{:keys [type msg data]} ...] cause chain.
@@ -50,25 +50,26 @@ Returns minimal signal, removing:
 Useful when serializing signals to edn/JSON/etc.
newline
clj
cljs
added in Encore v3.68.0 (2023-09-25)
Single system newline
 
pr-edn
clj
cljs
(pr-edn x)
Prints given arg to an edn string readable with `read-edn`.
 
pr-json
cljs
added in Encore v3.98.0 (2024-04-08)
(pr-json x)
Returns given Cljs argument as JSON string.
-
pr-signal-fn
clj
cljs
(pr-signal-fn pr-fn)(pr-signal-fn pr-fn {:keys [incl-thread? incl-kvs? incl-newline? prep-fn], :or {incl-newline? true, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
+
pr-signal-fn
clj
cljs
(pr-signal-fn)(pr-signal-fn {:keys [incl-thread? incl-kvs? incl-newline? pr-fn prep-fn], :or {incl-newline? true, pr-fn :edn, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
 Returns a (fn pr [signal]) that:
   - Takes a Telemere signal (map).
   - Returns a machine-readable (minified) signal string.
 
 Options:
-  `pr-fn`          - ∈ #{<unary-fn> :edn :json (Cljs only)}
+  `:pr-fn`         - ∈ #{<unary-fn> :edn (default) :json (Cljs only)}
   `:incl-thread?`  - Include signal `:thread` info?      (default false)
   `:incl-kvs?`     - Include signal `:kvs`    info?      (default false)
   `:incl-newline?` - Include terminating system newline? (default true)
 
 Examples:
-  (pr-signal-fn :edn  {<opts>})
-  (pr-signal-fn :json {<opts>}) ; Cljs only
+  (pr-signal-fn {:pr-fn :edn  ...}) ; Outputs edn
+  (pr-signal-fn {:pr-fn :json ...}) ; Outputs JSON (Cljs only)
+
+  To output JSON for Clj, you must provide an appropriate `:pr-fn`.
+  `jsonista` is one good option, Ref. <https://github.com/metosin/jsonista>:
 
-  ;; To output JSON for Clj, you must provide an appropriate `pr-fn`.
-  ;; `jsonista` is a good option, Ref. <https://github.com/metosin/jsonista>:
     (require '[jsonista.core :as jsonista])
-    (pr-signal-fn jsonista/write-value-as-string {<opts>})
+    (pr-signal-fn {:pr-fn jsonista/write-value-as-string ...})
 
 See also `format-signal-fn` for human-readable output.
remove-kvs
clj
cljs
(remove-kvs signal)
Returns given signal without user-level kvs.
 
signal-content-fn
clj
cljs
(signal-content-fn)(signal-content-fn {:keys [incl-thread? incl-kvs? raw-error? format-nsecs-fn format-error-fn], :or {format-nsecs-fn (format-nsecs-fn), format-error-fn (format-error-fn)}})
Experimental, subject to change.
diff --git a/taoensso.telemere.utils.html b/taoensso.telemere.utils.html
index 853abff..3a89e15 100644
--- a/taoensso.telemere.utils.html
+++ b/taoensso.telemere.utils.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.utils documentation
Namespaces
Public Vars
taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc.
+taoensso.telemere.utils documentation
Namespaces
Public Vars
taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc.
 
error-in-signal->maps
clj
cljs
(error-in-signal->maps signal)
Experimental, subject to change.
 Returns given signal with possible `:error` replaced by
 [{:keys [type msg data]} ...] cause chain.
@@ -57,25 +57,26 @@ Returns minimal signal, removing:
 
 Useful when serializing signals to edn/JSON/etc.
newline
clj
cljs
added in Encore v3.68.0 (2023-09-25)
Single system newline
 
pr-edn
clj
cljs
(pr-edn x)
Prints given arg to an edn string readable with `read-edn`.
-
pr-signal-fn
clj
cljs
(pr-signal-fn pr-fn)(pr-signal-fn pr-fn {:keys [incl-thread? incl-kvs? incl-newline? prep-fn], :or {incl-newline? true, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
+
pr-signal-fn
clj
cljs
(pr-signal-fn)(pr-signal-fn {:keys [incl-thread? incl-kvs? incl-newline? pr-fn prep-fn], :or {incl-newline? true, pr-fn :edn, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
 Returns a (fn pr [signal]) that:
   - Takes a Telemere signal (map).
   - Returns a machine-readable (minified) signal string.
 
 Options:
-  `pr-fn`          - ∈ #{<unary-fn> :edn :json (Cljs only)}
+  `:pr-fn`         - ∈ #{<unary-fn> :edn (default) :json (Cljs only)}
   `:incl-thread?`  - Include signal `:thread` info?      (default false)
   `:incl-kvs?`     - Include signal `:kvs`    info?      (default false)
   `:incl-newline?` - Include terminating system newline? (default true)
 
 Examples:
-  (pr-signal-fn :edn  {<opts>})
-  (pr-signal-fn :json {<opts>}) ; Cljs only
+  (pr-signal-fn {:pr-fn :edn  ...}) ; Outputs edn
+  (pr-signal-fn {:pr-fn :json ...}) ; Outputs JSON (Cljs only)
+
+  To output JSON for Clj, you must provide an appropriate `:pr-fn`.
+  `jsonista` is one good option, Ref. <https://github.com/metosin/jsonista>:
 
-  ;; To output JSON for Clj, you must provide an appropriate `pr-fn`.
-  ;; `jsonista` is a good option, Ref. <https://github.com/metosin/jsonista>:
     (require '[jsonista.core :as jsonista])
-    (pr-signal-fn jsonista/write-value-as-string {<opts>})
+    (pr-signal-fn {:pr-fn jsonista/write-value-as-string ...})
 
 See also `format-signal-fn` for human-readable output.
remove-kvs
clj
cljs
(remove-kvs signal)
Returns given signal without user-level kvs.
 
signal-content-fn
clj
cljs
(signal-content-fn)(signal-content-fn {:keys [incl-thread? incl-kvs? raw-error? format-nsecs-fn format-error-fn], :or {format-nsecs-fn (format-nsecs-fn), format-error-fn (format-error-fn)}})
Experimental, subject to change.