This repository was archived by the owner on Nov 23, 2021. It is now read-only.
Update README.md and Jazzy annotations #43
Merged
Conversation
This file contains hidden or 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
adellibovi suggested changes Sep 10, 2017
| public init() { | ||
| } | ||
| | ||
| /// Start the HTTP server on the given `port`, using `handler` to process incoming requests |
Member
There was a problem hiding this comment.
I would add - Parameter too for port and handler, what do you think?
Member
There was a problem hiding this comment.
I saw that in some other place of the code it's missing, if it's okay I would raise a PR fixing the missing docs for parameters.
Member Author
| Sure - if the of the change in this PR looks ok then I'll merge and you can add the parameter descriptions (without risking merge conflicts). |
Member Author
| Thanks @adellibovi. Merged. |
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
2 participants
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.
Update the Jazzy annotations to include HTTPServer and remove the PoCSocket code, and add a proper README.md that provides some basic getting started information.
If/when this is merged I'll update the gh-pages branch with the generated docs.