[Shortcuts] Improve documentation#123499
Conversation
| /// Base class for actions. | ||
| /// Base class for an action or command to be performed. | ||
| /// | ||
| /// {@youtube 560 315 https://www.youtube.com/watch?v=XawP1i314WM} |
There was a problem hiding this comment.
What does 560 315 mean? Is that the width and height of the video? I couldn't find any documentation on the best practices to link to videos.
Should we add some guidance on the wiki? https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#documentation-dartdocs-javadocs-etc
There was a problem hiding this comment.
Yes, it's the width and height of the video window. And yes, it would be good to add that to the wiki.
There was a problem hiding this comment.
| } | ||
| } | ||
|
|
||
| /// A widget that establishes an [ActionDispatcher] and a map of [Intent] to |
There was a problem hiding this comment.
A newbie can implement shortcuts and invoke actions manually without ever using ActionDispatcher. Thus, I've deprioritized this type.
a5ef334 to
2fc4906
Compare
| /// Base class for actions. | ||
| /// Base class for an action or command to be performed. | ||
| /// | ||
| /// {@youtube 560 315 https://www.youtube.com/watch?v=XawP1i314WM} |
There was a problem hiding this comment.
Yes, it's the width and height of the video window. And yes, it would be good to add that to the wiki.
| } | ||
| } | ||
|
|
||
| /// A widget that establishes an [ActionDispatcher] and a map of [Intent] to |
| /// when invoking an [Action] via a keyboard key combination that maps to an | ||
| /// [Intent]. | ||
| /// | ||
| /// This is similar to but more powerful than the [CallbackShortcuts] widget. |
There was a problem hiding this comment.
Maybe hint at why it's more powerful (separation of definition location for actions and intents, ability to override the action dispatcher, etc.).
There was a problem hiding this comment.
Added, let me know what you think!

Goals:
CallbackShortcutswidget as newbies will likely find it easier to learn than theShortcutswidget