Fix Tracer#trace start_time type documentation #1268
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
ericmustin
approved these changes
Dec 2, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1264
This PR updates the required type for the
Datadog::Tracer#trace(start_time:)option.The type required is a Ruby Time 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.