Skip to content

Update documentation for countdown behavior #62145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
feinstein wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −1
Open

Update documentation for countdown behavior #62145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c79fd58
Update documentation for countdown behavior
feinstein Dec 2, 2025
23af4e9
Fix comment formatting in stream.dart
feinstein Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion sdk/lib/async/stream.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2001,7 +2001,9 @@ abstract mixin class Stream<T> {
/// The countdown is stopped when listening on the returned stream is
/// paused or cancelled.
/// No new countdown is started when a countdown completes
/// and the [onTimeout] function is called, even if events are emitted.
/// and the [onTimeout] function is called, even if events are emitted by the
/// [EventSink] provided to [onTimeout]. The countdown is only restarted when
Copy link
Copy Markdown
Member

@lrhn lrhn Jan 14, 2026

Choose a reason for hiding this comment

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

I think "emitted by" would be more precise as "added to" or even "emitted by the returned stream by [onTimeout] through the [eventSink]".

Copy link
Copy Markdown
Author

@feinstein feinstein Jan 14, 2026

Choose a reason for hiding this comment

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

Sorry @lrhn I don't get where specifically you want me to change the wording, I already have "emitted by" in there.

Copy link
Copy Markdown
Member

@mraleph mraleph Jan 23, 2026

Choose a reason for hiding this comment

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

ping @lrhn

Copy link
Copy Markdown
Author

@feinstein feinstein Jan 29, 2026

Choose a reason for hiding this comment

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

Also, please feel free to change the wording and commit and merge, if you don't want to wait for my changes. I know some people will be offended, but I won't.

/// a new event comes from this stream.
/// If the delay between events of this stream is multiple times
/// [timeLimit], at most one timeout will happen between events.
///
Expand Down