Expand metrics docs #1243
Merged
Expand metrics docs #1243
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
jeffwidman
force-pushed
the
expand-metrics-docs
branch
from
65e27da to
eeada7e
Compare
jeffwidman
force-pushed
the
expand-metrics-docs
branch
from
eeada7e to
ad3d870
Compare
jeffwidman
commented
Oct 7, 2017
| @@ -8,6 +8,8 @@ | |||
| import time | |||
| import weakref | |||
|
|
|||
| from ..vendor import six | |||
There was a problem hiding this comment.
I noticed the import style was inconsistent between kafka/producer/kafka.py and kafka/consumer/group.py, not sure why...?
There was a problem hiding this comment.
I think I must have started kafka/consumer/group.py before deciding to use relative imports. I like this style better.
|
Great! |
88manpreet
pushed a commit
to Yelp/kafka-python
that referenced
this pull request
Jul 17, 2018
* Expand metrics docstrings * Document metrics interface in readme * Use six.iteritems(d) rather than d.items() * Use Sphinx warning syntax
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.
I've never taken the time to experiment with them because they weren't documented, so decided to fix that.
There were a number of distinct changes, so I tried to keep them contained within separate commits so we can easily drop any that aren't wanted... probably easiest to review as distinct commits as well.
For example, I'm not sure if the Sphinx warning syntax will show up properly on RTD or not, as I'm not sure how to build the docs locally.