[docs] be more explicit in docs #146
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
ufoot
reviewed
Jul 5, 2017
lib/ddtrace/span.rb
Outdated
| @@ -65,8 +65,8 @@ def get_tag(key) | |||
| @meta[key] | |||
| end | |||
|
|
|||
| # Set the given key / value metric pair on the span. Keys must be string. | |||
| # Values must be floating point numbers. | |||
| # This method sets a tag for a floating point value for the given key. It acts | |||
There was a problem hiding this comment.
for a floating point -> with a floating point? Wondering. It's just about language/wording, indeed it's good not to advocate too much for that set_metric usage when there's almost no difference with set_tag.
There was a problem hiding this comment.
yes, we don't advocate set_metric() at all, indeed it's not in the docs and there is not a particular reason to use it instead of set_tag(). Here I just want to write something that is explicit that set_metric() acts like set_tag() and does not have anything to do with infrastructure metrics.
Do you think we can reword it better?
ufoot
approved these changes
Jul 5, 2017
| @@ -350,7 +350,7 @@ to trace requests to the home page: | |||
|
|
|||
| # add some attributes and metrics | |||
| span.set_tag('http.method', request.request_method) | |||
| span.set_metric('posts.count', len(@posts)) | |||
| span.set_tag('posts.count', @posts.length) | |||
There was a problem hiding this comment.
good catch on len( -> .length
palazzem
force-pushed
the
palazzem/update-docs
branch
from
8ed93b8 to
7dbf98a
Compare
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.
Overview
Updates docs and docstrings to be more clear.