#385: Tweak README #408
Merged
#385: Tweak README #408
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
ziluvatar
reviewed
Sep 29, 2017
README.md
Outdated
| @@ -106,7 +106,7 @@ jwt.sign({ | |||
|
|
|||
| ### jwt.verify(token, secretOrPublicKey, [options, callback]) | |||
|
|
|||
| (Asynchronous) If a callback is supplied, function acts asynchronously. Callback is passed the decoded payload if the signature and optional expiration, audience, or issuer are valid. If not, it will be passed the error. | |||
| (Asynchronous) If a callback is supplied, function acts asynchronously. The callback is passed the decoded payload if the signature is valid and optional expiration, audience, or issuer are valid. If not, it will be passed the error. | |||
|
|
|||
There was a problem hiding this comment.
Good change, however, this sentence always feels weird to me, don't you think it should use the same "pattern" as we use for sign?
The callback is called with the decoded payload... . If not, it will be called with the error.
There was a problem hiding this comment.
Updated. I also made the wording between the Synchronous and Asynchronous section the same.
ziluvatar
approved these changes
Oct 9, 2017
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 issue #385 , adds a few other definite articles for clarity.