doc/modules/http.websocket.md: Add usage example to websocket:each() #118
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
daurnimator
requested changes
Jul 19, 2018
| @@ -53,6 +53,15 @@ The opcode `0x1` will be returned as `"text"` and `0x2` will be returned as `"bi | |||
|
|
|||
| Iterator over [`websocket:receive()`](#http.websocket:receive). | |||
|
|
|||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
daurnimator
reviewed
Jul 19, 2018
doc/modules/http.websocket.md
Outdated
| for data, opcode in ws:each() do | ||
| print(data, opcode) | ||
| end | ||
|
|
daurnimator
requested changes
Jul 19, 2018
doc/modules/http.websocket.md
Outdated
| @@ -53,6 +53,16 @@ The opcode `0x1` will be returned as `"text"` and `0x2` will be returned as `"bi | |||
|
|
|||
| Iterator over [`websocket:receive()`](#http.websocket:receive). | |||
|
|
|||
| #### Example {#http.websocket.each-example} | |||
There was a problem hiding this comment.
Minor nit: this should be :each not .each
|
I hope it's OK now, I'm new to the whole PR workflow (and not that well versed in git either). |
|
I'm a bit worried about the usefulness of the example beyond the general use of an iterator. |
|
Do you want to edit your PR further? Or do you think it improves the current docs and should be merged? |
|
Ping @hollunder ? |
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 it wasn't obvious to me how to use each() I figure it would be useful to have a little example in the documentation.