[jira] [Commented] (HTRACE-317) Docs for adding tracing to an application are incorrect

[Masatake Iwasaki (JIRA)]

    [ 
https://issues.apache.org/jira/browse/HTRACE-317?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15092428#comment-15092428
 ] 

Masatake Iwasaki commented on HTRACE-317:
-----------------------------------------

Thanks for the comment, [~cmccabe].

bq. The Builder constructor which takes a name was deprecated in HTRACE-254

I checked the patch of HTRACE-254. The {{Builder()}} was deprecated and 
{{Builder(final String name)}} was added.

{code}
+    /**
+     * @deprecated Since 4.0.0. Use Constructor that takes a <code>name</code> 
argument instead
+     */
+    @Deprecated
     public Builder() {
     }
{code}


> Docs for adding tracing to an application are incorrect
> -------------------------------------------------------
>
>                 Key: HTRACE-317
>                 URL: https://issues.apache.org/jira/browse/HTRACE-317
>             Project: HTrace
>          Issue Type: Bug
>          Components: docs
>    Affects Versions: 4.0.1
>            Reporter: Sean Busbey
>            Assignee: Masatake Iwasaki
>            Priority: Critical
>         Attachments: HTRACE-317.001.patch
>
>
> The docs for adding tracing state:
> {code}
> Span computationSpan = tracer.newScope("Expensive computation.");
> try {
>     //expensive computation here
> } finally {
>     computationSpan.stop();
> }
> {code}
> the {{tracer.newScope}} method returns a TraceScope object. That object has a 
> {{close}} method, not {{stop}}.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)