Skip to content
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

Jump to bottom

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

Open
1 task
SandPod opened this issue Dec 13, 2023 · 2 comments
Open
1 task

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

SandPod opened this issue Dec 13, 2023 · 2 comments
Labels
a.tut.tutorial Relates to the Tutorial section of dart.dev d.enhancement Improves docs with specific ask e2-days Can complete in < 5 days of normal, not dedicated, work from.page-issue Reported in a reader-filed concern p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@SandPod
Copy link

SandPod commented Dec 13, 2023

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.

  • I will try and fix this problem on dart.dev.
@SandPod SandPod added the from.page-issue Reported in a reader-filed concern label Dec 13, 2023
@huycozy huycozy added the st.triage.triage-team Triage team reviewing and categorizing the issue label Dec 13, 2023
@huycozy
Copy link
Member

huycozy commented Dec 13, 2023

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?

@huycozy huycozy added the act.wait-for-customer Needs response from customer label Dec 13, 2023
@SandPod
Copy link
Author

SandPod commented Dec 15, 2023

@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.

@github-actions github-actions bot removed the act.wait-for-customer Needs response from customer label Dec 15, 2023
@huycozy huycozy added d.enhancement Improves docs with specific ask p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. a.tut.tutorial Relates to the Tutorial section of dart.dev e2-days Can complete in < 5 days of normal, not dedicated, work and removed st.triage.triage-team Triage team reviewing and categorizing the issue labels Dec 15, 2023
@atsansone atsansone changed the title Missing documentation for timeout(...) on Streams page. Add functionality explanation to the timeout(...) method on Streams page Jan 23, 2024
@atsansone atsansone added the st.triage.ltw Indicates Lead Tech Writer has triaged label Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
a.tut.tutorial Relates to the Tutorial section of dart.dev d.enhancement Improves docs with specific ask e2-days Can complete in < 5 days of normal, not dedicated, work from.page-issue Reported in a reader-filed concern p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@atsansone @huycozy @SandPod