specify when a Future completes for IOSink's addStream

specify when a Future completes for IOSink's addStream

BUG=
R=lrn@google.com

Committed: https://github.com/dart-lang/sdk/commit/55fc80e15e43059618201f429605ae84411d9edb

[sethladd, 2015-09-18 19:51:49]

sethladd@google.com changed reviewers:
+ lrn@google.com

[sethladd, 2015-09-18 19:51:49]

Tweak to API docs after feedback from user.

[jamesr, 2015-09-18 19:54:27]

This is very helpful, thank you.

[Lasse Reichstein Nielsen, 2015-09-21 09:50:47]

LGTM with comment.

https://codereview.chromium.org/1342293003/diff/1/sdk/lib/io/io_sink.dart
File sdk/lib/io/io_sink.dart (right):

https://codereview.chromium.org/1342293003/diff/1/sdk/lib/io/io_sink.dart#new...
sdk/lib/io/io_sink.dart:99: * Returns a [Future] that completes when
Retain the original first line, then add these two as well (after an empty
line).

We usually have a simple first line that describes what happens.
Then , after an empty line, we describe in more detail what parameters means and
what is returned.
A doc that starts with "Returns ..." is generally reserved for getters (or
functions which should probably have been getters).

[Lasse Reichstein Nielsen, 2015-09-21 09:50:48]

LGTM with comment.

[sethladd, 2015-09-21 09:56:21]

https://codereview.chromium.org/1342293003/diff/1/sdk/lib/io/io_sink.dart
File sdk/lib/io/io_sink.dart (right):

https://codereview.chromium.org/1342293003/diff/1/sdk/lib/io/io_sink.dart#new...
sdk/lib/io/io_sink.dart:99: * Returns a [Future] that completes when
On 2015/09/21 09:50:47, Lasse Reichstein Nielsen wrote:
> Retain the original first line, then add these two as well (after an empty
> line).
> 
> We usually have a simple first line that describes what happens.
> Then , after an empty line, we describe in more detail what parameters means
and
> what is returned.
> A doc that starts with "Returns ..." is generally reserved for getters (or
> functions which should probably have been getters).
> 

Done.

[sethladd, 2015-09-21 09:57:35]

Committed patchset #2 (id:20001) manually as
55fc80e15e43059618201f429605ae84411d9edb (presubmit successful).