-
Notifications
You must be signed in to change notification settings - Fork 50
Conversation
The video doesn't give much information. The video seems like a really good way to help more folks discover the package. After they know it exists and are looking at the docs I don't know what value they would get from a link to the video. |
The package is listed in api.flutter.dev, so they may just click on it to see what it has to offer without any context. For those users, I think the video still provides value. |
cc @lrhn WDYT? |
@@ -2,6 +2,8 @@ | |||
// for details. All rights reserved. Use of this source code is governed by a | |||
// BSD-style license that can be found in the LICENSE file. | |||
|
|||
/// {@youtube 560 315 https://www.youtube.com/watch?v=r0tHiCjW2w0} | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a doc comment, so you should probably add a library
declaration to make it document the library.
We should also add a real library documentation, but for now, let's just have a headline before the link:
/// Various functionality associated with the asynchronous features of the `dart:async` library.
///
/// {@youtube 560 315 https://www.youtube.com/watch?v=r0tHiCjW2w0}
library pkg.async;
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you should probably add a
library
declaration to make it document the library.
Dartdoc should handle it either way - but I'm in favor of the explicit library declaration for now.
I really hope we can make that library;
soon.
If I can nitpick the wording, I think "Various" and "functionality" aren't conveying much - virtually any package can be describe as having "Various functionality". How about:
/// Utilities that expand on the asynchronous features of the `dart:async` library.
///
/// {@youtube 560 315 https://www.youtube.com/watch?v=r0tHiCjW2w0}
library pkg.async;
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding the doc and link LGTM once it has a header in addition to the link.
Ok, all done. @natebosch can you merge for me? |
No description provided.