Clarify sign docstring to allow for dict payload #150
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
Since a `payload` of a Mapping type is converted to a string in `_encode_payload`, this commit updates the docstring for `sign` to reflect that
Codecov Report
@@ Coverage Diff @@
## master #150 +/- ##
=======================================
Coverage 96.55% 96.55%
=======================================
Files 14 14
Lines 1075 1075
=======================================
Hits 1038 1038
Misses 37 37
Continue to review full report at Codecov.
|
|
@zejn Do you have a moment to glance at this minor docstring improvement? |
|
Thanks! |
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.
Since a
payloadof a Mapping type is converted to a string in_encode_payload, this commit updates the docstring forsignto reflect that