dart-lang / site-www

Source for Dart website
https://dart.dev
Other
967 stars 696 forks source link

Add functionality explanation to the `timeout(...)` method on Streams page #5404

Open SandPod opened 10 months ago

SandPod commented 10 months ago

Page URL

https://dart.dev/tutorials/language/streams

Page source

No response

Describe the problem

The tutorial for asynchronous streams is missing documentation about the timeout(...) method available on Stream objects. It is listed together with handleError(...) and transform(....) but misses a section describing its functionality.

Expected fix

A matching description about the timeout(...) method describing what it is for and how it is used.

Additional context

No response

I would like to fix this problem.

huycozy commented 10 months ago

Hi @SandPod Could you check https://api.flutter.dev/flutter/dart-async/Stream/timeout.html to see if it has information that you are looking for?

SandPod commented 10 months ago

@huycozy Yes, that documentation was good enough for my use case. Thank you 👍

The information should still probably either be summarized or linked from tutorial page.