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.

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

dartdoc scheduleMicrotask refers to article that does not contain info about microtasks #40289

Open
bennorichters opened this issue Jan 23, 2020 · 3 comments
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. library-core type-documentation A request to add or improve documentation

Comments

@bennorichters
Copy link

Dart SDK Version: 2.7.0, dart:async library

The dartdoc of scheduleMicrotask (*1) refers to an article (*2) saying: "Learn how Dart handles the event queue and microtask queue,". That link (*2) gets redirected to an article that does not mention anything about microtasks.

*1: https://api.dart.dev/stable/2.7.0/dart-async/scheduleMicrotask.html
*2: https://www.dartlang.org/articles/event-loop/

@bennorichters bennorichters changed the title dartdoc scheduleMicrotask refers to article that does not contain info about micro tasks dartdoc scheduleMicrotask refers to article that does not contain info about microtasks Jan 23, 2020
@srawlins srawlins added area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. type-documentation A request to add or improve documentation library-core labels Jan 23, 2020
@simolus3
Copy link
Contributor

It used to point to this great article. Even though some parts of it are heavily outdated, I think it still is the best documentation on Dart async internals and it would be great if it was published again.

@kwalrath
Copy link
Contributor

kwalrath commented Jan 23, 2020

That out-of-date article took a long time to write and review (only one person on the team was able to review everything in it, and he's gone!); I haven't been able to find the time/nerve to update it.

In the short term I could perhaps redirect to the web.archive.org link that @simolus3 pointed to, or add that link to the Medium article. But we really should document the event and microtask queues (dart-lang/site-www#2142).

@kwalrath
Copy link
Contributor

I've applied the short-term fix of adding a link from the end of the Medium article to the archived article.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. library-core type-documentation A request to add or improve documentation
Projects
None yet
Development

No branches or pull requests

4 participants