Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update api doc for Scope object #894

Merged
merged 3 commits into from
Jul 6, 2021
Merged

Update api doc for Scope object #894

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
428eaa1
fix doc for scope object
lalitb Jul 6, 2021
1023cfb
fix doc
lalitb Jul 6, 2021
019c2b1
Merge branch 'main' into active-span-doc
lalitb Jul 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/public/GettingStarted.rst
View file
Open in desktop
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