[Shortcuts] Improve documentation #123499
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flutter-dashboard
bot
added
the
framework
loic-sharma
commented
Mar 26, 2023
| /// 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.
loic-sharma
commented
Mar 26, 2023
| @@ -612,13 +615,13 @@ class ActionDispatcher with Diagnosticable { | |||
| } | |||
| } | |||
|
|
|||
| /// 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.
loic-sharma
changed the title
loic-sharma
force-pushed
the
shortcut_videos
branch
from
a5ef334
to
2fc4906
Compare
gspencergoog
approved these changes
Mar 27, 2023
| /// 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.
| @@ -612,13 +615,13 @@ class ActionDispatcher with Diagnosticable { | |||
| } | |||
| } | |||
|
|
|||
| /// A widget that establishes an [ActionDispatcher] and a map of [Intent] to | |||
| @@ -868,6 +868,8 @@ class ShortcutManager with Diagnosticable, ChangeNotifier { | |||
| /// This widget establishes a [ShortcutManager] to be used by its descendants | |||
| /// 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!
loic-sharma
added
the
autosubmit
8 tasks
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 29, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 29, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 29, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 29, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 30, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Mar 31, 2023
8 tasks
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 1, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 1, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Apr 1, 2023
8 tasks
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
May 10, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
May 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goals:
CallbackShortcutswidget as newbies will likely find it easier to learn than theShortcutswidget