tweak readme #78
Merged
tweak readme #78
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
ralphtheninja
commented
Dec 17, 2016
| @@ -257,7 +257,6 @@ instance.authorizeSubscribe = function (client, sub, cb) { | |||
|
|
|||
| It will be called when a client is set to recieve a message. Override to supply custom | |||
| authorization logic. | |||
| In order to completely pre | |||
|
|
|||
There was a problem hiding this comment.
A leftover sentence? Just removed it since I didn't know how to finish it.
ralphtheninja
commented
Dec 17, 2016
| @@ -159,7 +159,7 @@ A packet must contain the following properties: | |||
| } | |||
| ``` | |||
|
|
|||
| Only the `topic` and properties are mandatory | |||
| Only the `topic` and `payload` properties are mandatory. | |||
There was a problem hiding this comment.
I guess this one was copy/pasted from mqtt-packet repo.
There was a problem hiding this comment.
I guess payload is missing?
ralphtheninja
commented
Dec 17, 2016
| @@ -147,7 +147,7 @@ It supports backpressure. | |||
|
|
|||
| Publish the given packet to subscribed clients and functions. It supports backpressure. | |||
|
|
|||
| A packet must contain the following properties: | |||
| A packet contains the following properties: | |||
|
|
|||
There was a problem hiding this comment.
Contradicting sentences. This one states that all properties are mandatory but the second says only topic (and as I suspect, the payload property) is mandatory.
|
bump |
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.
No description provided.