From 428eaa17a8742b6f44f6d1896a7b4b9d437dbd4e Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 6 Jul 2021 19:47:51 +0530 Subject: [PATCH 1/2] fix doc for scope object --- 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..a7f2c957ba 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 `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 From 1023cfb9920f3b65a61a24bf55aba7aee35258c9 Mon Sep 17 00:00:00 2001 From: Lalit Kumar Bhasin Date: Tue, 6 Jul 2021 19:56:22 +0530 Subject: [PATCH 2/2] fix doc --- docs/public/GettingStarted.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/public/GettingStarted.rst b/docs/public/GettingStarted.rst index a7f2c957ba..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. The `Scope` object +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 `Scope` object. +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