search

taoensso / telemere

Structured telemetry library for Clojure/Script
https://www.taoensso.com/telemere
Eclipse Public License 1.0
200 stars 5 forks source link

[docs] clarifying docs #20

Closed avocade closed 2 months ago

avocade commented 2 months ago

But spy! also emphasizes form and id, like trace!. A bit confusing.

https://github.com/taoensso/telemere/blob/1da93233deae73b84d39302026a7fc7ad1d9f511/projects/main/resources/signal-docstrings/trace!.txt#L31

ptaoussanis commented 2 months ago

@avocade Hi Oskar-

But spy! also emphasizes form and id, like trace!

Where are you seeing that? Might have a typo somewhere!

The correct info is in the README / Getting started or docstrings, e.g.:

From the trace! docstring:

"Trace" signal creator, emphasizing form + id. API: [form] [id-or-opts form] => form's result (value/throw) (unconditional) Identical to spy!, but emphasizes form + id rather than form + level.

And from the spy! docstring:

"Spy" signal creator, emphasizing form + level. API: [form] [level-or-opts form] => form's result (value/throw) (unconditional) Identical to trace!, but emphasizes form + level rather than form + id.

So trace! is form + id, and spy! is form + level.

ptaoussanis commented 2 months ago

Found the likely source of the confusion!

The arglist metadata on spy! was wrong, so could be you were looking at your IDE's arg hints. Will get this fixed on the next release, thanks for the report 👍