DataDog / dd-trace-py

Datadog Python APM Client
https://ddtrace.readthedocs.io/
Other
553 stars 415 forks source link

Clarify documentation for current_root_span #9758

Open timmc-edx opened 4 months ago

timmc-edx commented 4 months ago

The documentation for ddtrace.Tracer.current_root_span is ambiguous regarding whether this is A) the root span of the entire trace, B) the root span of the current process, or C) the service entry span:

Reading the source code, this line implies B, at least to my eyes.

It would be great if the docs could be made clear on this point.

emmettbutler commented 4 months ago

Thanks for noting this, @timmc-edx. We'll clarify the docs.