Fix parameter ordering in docstring #1660
Closed
Conversation
This file contains hidden or 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
|
|
|
Thanks for fixing this. Can you please rebase the branch and sign the CLA? |
|
Thanks for the fix. As this was required for the release, I have incorporated your changes in the PR - #1666. Closing this PR. |
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.
Minor documentation fix.
The docstring for DeserializingConsumer's says that the
key.deserializerandvalue.deserializerconfigs are expected to beCallable(SerializationContext, bytes)but the code actually calls them usingself._value_deserializer(value, ctx)andself._key_deserializer(key, ctx).I also checked SerializingProducer and verified that its documentation has the parameter order correct.