-
Notifications
You must be signed in to change notification settings - Fork 48
docs: Format example for tracer.startActiveSpan #101
Conversation
The idea was to highlight that you could return the span if you wanted to continue to manage it outside of the function, but improvements to the examples are always welcome! |
Codecov Report
@@ Coverage Diff @@
## main #101 +/- ##
=======================================
Coverage 94.90% 94.90%
=======================================
Files 42 42
Lines 569 569
Branches 89 89
=======================================
Hits 540 540
Misses 29 29 Continue to review full report at Codecov.
|
OP didn't mean a conceptual change. Only formatting! Doesn't have to be in this PR, but I personally appreciate examples that run more than pseudo-code ones. Making minimal changes(console.log'ing instead of "do some work" and throwing etc.) could make this look a little better. |
I perceive that PR as only formatting change. Despite of that I added side note about second example, but I believe it is out of scope of that PR.
Thanks for the clarification. This may actually be useful on rare occasions. |
While their PR targets formatting they also inquired about the second example (conceptually) :)
Yep, up for a PR? |
Thanks for your cooperation. |
Example in documentation fro
tracer.startActiveSpan
is misformated:That PR is gonna fix that:
I have doubts whether the second example - although technically correct - is optimal for promotion and indication in the documentation.