Fix docs for new HTTP::Server API #6179
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
RX14
approved these changes
Jun 11, 2018
j8r
approved these changes
Jun 12, 2018
| @@ -131,6 +131,11 @@ class HTTP::Server | |||
| # Creates a `TCPServer` listenting on `host:port` and adds it as a socket, returning the local address | |||
| # and port the server listens on. | |||
| # | |||
| # ``` | |||
| # server = HTTP::Server.new { } | |||
There was a problem hiding this comment.
More related to the implementation than this doc, but initializing with an empty Proc looks a bit weird.
There was a problem hiding this comment.
Agreed, but these examples are to demonstrate the bind methods, not handlers. So I think this is fine.
We could add some hello world to the handler, but this just adds house not relevant to the immediate purpose.
sdogruyol
approved these changes
Jun 12, 2018
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.
Follow-up on #5776
The examples in the updated API docs for
HTTP::Serverdid not reflect the eventual method namebind_tcp.