Skip to content

Commit

Permalink
Update api doc for Scope object (#894)
Browse files Browse the repository at this point in the history
  • Loading branch information
lalitb authored Jul 6, 2021
1 parent 4292a57 commit 0563059
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/public/GettingStarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ Mark a span as active
auto scope = tracer->WithActiveSpan(span);
This marks a span as active and returns a ``Scope`` object bound to the
lifetime of the span. When the ``Scope`` object is destroyed, the
related span is ended.
This marks a span as active and returns a ``Scope`` object. The scope object
controls how long a span is active. The span remains active for the lifetime
of the scope object.

The concept of an active span is important, as any span that is created
without explicitly specifying a parent is parented to the currently
Expand Down

0 comments on commit 0563059

Please sign in to comment.