Skip to content

Fix docs for new HTTP::Server API#6179

Merged
sdogruyol merged 1 commit intocrystal-lang:masterfrom
straight-shoota:jm/fix/http-server-docs
Jun 12, 2018
Merged

Fix docs for new HTTP::Server API#6179
sdogruyol merged 1 commit intocrystal-lang:masterfrom
straight-shoota:jm/fix/http-server-docs

Conversation

@straight-shoota
Copy link
Copy Markdown
Member

Follow-up on #5776

The examples in the updated API docs for HTTP::Server did not reflect the eventual method name bind_tcp.

@RX14 RX14 added this to the 0.25.1 milestone Jun 11, 2018
@RX14 RX14 added kind:bug A bug in the code. Does not apply to documentation, specs, etc. kind:docs topic:stdlib labels Jun 11, 2018
# and port the server listens on.
#
# ```
# server = HTTP::Server.new { }
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More related to the implementation than this doc, but initializing with an empty Proc looks a bit weird.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 sdogruyol merged commit a9bab0c into crystal-lang:master Jun 12, 2018
@straight-shoota straight-shoota deleted the jm/fix/http-server-docs branch June 12, 2018 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:bug A bug in the code. Does not apply to documentation, specs, etc. kind:docs topic:stdlib

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants