start_time type doesn't match code #1264
Milestone
Comments
marcotc
added a commit
that referenced
this issue
Nov 30, 2020
Fixes #1264 This PR updates the required type for the `Datadog::Tracer#trace(start_time:)` option. The type required is a Ruby [Time](https://ruby-doc.org/stdlib-2.7.2/libdoc/time/rdoc/Time.html) object, while the documentation erroneously requested an `Integer`. As as follow up, I suggest we move most of this documentation to our published API docs: https://www.rubydoc.info/github/DataDog/dd-trace-rb/Datadog/Tracer#trace-instance_method. This allows us to keep the documentation close to implementation, and prevent information drift between the two.
marcotc
added a commit
that referenced
this issue
Dec 2, 2020
Fixes #1264 This PR updates the required type for the `Datadog::Tracer#trace(start_time:)` option. The type required is a Ruby [Time](https://ruby-doc.org/stdlib-2.7.2/libdoc/time/rdoc/Time.html) object, while the documentation erroneously requested an `Integer`. As as follow up, I suggest we move most of this documentation to our published API docs: https://www.rubydoc.info/github/DataDog/dd-trace-rb/Datadog/Tracer#trace-instance_method. This allows us to keep the documentation close to implementation, and prevent information drift between the two.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
start_timeis documented as having requiring a type ofIntegerhere: https://github.com/DataDog/dd-trace-rb/blob/master/docs/GettingStarted.md#manual-instrumentation, however it is handled as a Time here:dd-trace-rb/lib/ddtrace/span.rb
Line 423 in 409ec65
Passing as an integer causes error on the
nsecfield request.I think the docs should be updated to note the correct type.
The text was updated successfully, but these errors were encountered: