Documentation cleanup #132
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
donny-dont
commented
Oct 26, 2017
- Remove docs from overridden methods.
- Remove references to old functionality.
- Use 1 line description.
nex3
suggested changes
Oct 26, 2017
lib/browser_client.dart
Outdated
| /// a response will only be returned once all the data is available. | ||
| /// This client inherits some of the limitations of XMLHttpRequest. It is | ||
| /// unable to directly set some headers, such as `content-length`. There is no | ||
| /// way to create a persistent connection. Redirects cannot be handled directly. |
There was a problem hiding this comment.
I'd just remove the sentences about persistent connections and redirects.
lib/http.dart
Outdated
| @@ -28,7 +28,8 @@ export 'src/response.dart'; | |||
| /// the request is complete. If you're planning on making multiple requests to | |||
| /// the same server, you should use a single [Client] for all of those requests. | |||
| /// | |||
| /// For more fine-grained control over the request, use [Request] instead. | |||
| /// For more fine-grained control over the request and response, create a | |||
| /// [Client] and use it directly. | |||
There was a problem hiding this comment.
Now that these methods support streaming requests and responses, I don't think we need these notes anymore.
lib/src/base_client.dart
Outdated
| /// get various convenience methods for free. | ||
| /// The abstract base class for an HTTP client. | ||
| /// | ||
| /// This is a mixin-style class; subclasses only need to implement [send] and |
There was a problem hiding this comment.
"Mixin-style" is confusing now that Dart has actual mixins. I'd just remove that bit.
nex3
approved these changes
Oct 26, 2017
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.