docs: Format example for tracer.startActiveSpan

[ad-m]

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.

[naseemkullah]

I have doubts whether the second example - although technically correct - is optimal for promotion and indication in the documentation.

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]

Codecov Report

Merging #101 (b7cc2a8) into main (1fa6248) will not change coverage.
The diff coverage is n/a.

❗ Current head b7cc2a8 differs from pull request most recent head c452067. Consider uploading reports for the commit c452067 to get more accurate results

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1fa6248...c452067. Read the comment docs.

[rauno56]

I have doubts whether the second example - although technically correct - is optimal for promotion and indication in the documentation.

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!

OP didn't mean a conceptual change. Only formatting!
Thanks, @ad-m!

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.

[ad-m]

OP didn't mean a conceptual change. Only formatting!

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.

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!

Thanks for the clarification. This may actually be useful on rare occasions.

[naseemkullah]

I have doubts whether the second example - although technically correct - is optimal for promotion and indication in the documentation.

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!

OP didn't mean a conceptual change. Only formatting!

While their PR targets formatting they also inquired about the second example (conceptually) :)

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.

Yep, up for a PR?

[ad-m]

Thanks for your cooperation.