From 0563059bdaa27b78194df72ddb5e7243e0c27eef Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 6 Jul 2021 22:08:15 +0530 Subject: [PATCH] Update api doc for Scope object (#894) --- docs/public/GettingStarted.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/public/GettingStarted.rst b/docs/public/GettingStarted.rst index abff4d6d13..c50a143d0a 100644 --- a/docs/public/GettingStarted.rst +++ b/docs/public/GettingStarted.rst @@ -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