Update documentation. #73
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
Synchronize goals section between README and rustdoc, and add two goals (blocking API; no unsafe) that were mentioned elsewhere in the README. Add error handling to examples for the module and for the Response object. And a section on synthetic errors to the top-level module documentation.
|
You aware of the |
|
This is great! Thanks! |
algesten
reviewed
Jun 21, 2020
| @@ -36,8 +46,10 @@ | |||
| //! which follows a build pattern. The builders are finished using: | |||
| //! | |||
| //! * [`.call()`](struct.Request.html#method.call) without a request body. | |||
| //! * [`.send()`](struct.Request.html#method.send) with a request body as `Read`. | |||
| //! * [`.send()`](struct.Request.html#method.send) with a request body as `Read` (chunked encoding). | |||
There was a problem hiding this comment.
If you set a content-length header manually it doesn't do chunked, but maybe that's too much detail.
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.
Synchronize goals section between README and rustdoc, and add two goals
(blocking API; no unsafe) that were mentioned elsewhere in the README.
Add error handling to examples for the module and for the Response
object.
And a section on synthetic errors to the top-level module documentation.
Related to #55