-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Various improvements to text-editing-related documentation. #142561
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
Conversation
justinmc
left a comment
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.
LGTM 👍 . Thanks for putting in the work to improve these docs.
| /// [TextSelectionGestureDetectorBuilder.buildGestureDetector]. The widget | ||
| /// returned by [contextMenuBuilder] is passed to a [ContextMenuController]. |
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.
Good call pointing this out in the docs, I'm sure many people have pored over the codebase to figure this out.
| /// position for the context menu. | ||
| /// | ||
| /// * [EditableTextState.contextMenuButtonItems] represents the buttons that | ||
| /// should typically be built for this widget (e.g. cut, copy, paste). |
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.
Nit: I think @sfshaza2 has called me out for using abbreviations like "e.g." in a migration guide before, not sure if that's the same policy for docs like these or not. Looks like we do use it elsewhere.
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.
I see "e.g." and "i.e." occur several times in this PR, I assume they're allowed.
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.
yeah we use a slightly different writing style for the API docs as for the website (largely for historical reasons at this point)
| final MagnifierBuilder? _magnifierBuilder; | ||
|
|
||
| /// {@macro flutter.widgets.magnifier.MagnifierBuilder} | ||
| MagnifierBuilder get magnifierBuilder => _magnifierBuilder ?? (_, __, ___) => null; |
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.
I should have caught these underscores in code review when they were added...
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.
a lot of this code was landed in a giant PR that had months of back and forth and i don't fault anyone for letting things slip in in that PR
| /// the [magnifierBuilder] getter will be a function that always returns | ||
| /// null. | ||
| /// The builder callback that creates the widget that renders the magnifier. | ||
| MagnifierBuilder get magnifierBuilder => _magnifierBuilder ?? _none; |
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.
Slick.
Roll Flutter from 8431cae to eb5d0a4 (33 revisions) flutter/flutter@8431cae...eb5d0a4 2024-02-08 [email protected] Roll Packages from e4ea6bf to 29d8cc0 (5 revisions) (flutter/flutter#143161) 2024-02-08 [email protected] Roll Flutter Engine from 6d524588c0f9 to f53fbd8393ce (1 revision) (flutter/flutter#143160) 2024-02-08 [email protected] Roll Flutter Engine from 22e1241e9823 to 6d524588c0f9 (3 revisions) (flutter/flutter#143147) 2024-02-08 [email protected] Roll Flutter Engine from 084bd0b8f5ac to 22e1241e9823 (1 revision) (flutter/flutter#143140) 2024-02-08 [email protected] Roll Flutter Engine from 104804aa374e to 084bd0b8f5ac (1 revision) (flutter/flutter#143139) 2024-02-08 [email protected] Roll Flutter Engine from 45137ea6ba29 to 104804aa374e (1 revision) (flutter/flutter#143138) 2024-02-08 [email protected] Pass along web renderer into debugging options in the test command. (flutter/flutter#143128) 2024-02-08 [email protected] Roll Flutter Engine from 4ea7bd07328b to 45137ea6ba29 (2 revisions) (flutter/flutter#143135) 2024-02-08 [email protected] Roll Flutter Engine from 322a461dc74f to 4ea7bd07328b (2 revisions) (flutter/flutter#143131) 2024-02-07 [email protected] Add a unit test for `NavigationRail` (flutter/flutter#143108) 2024-02-07 [email protected] Roll Flutter Engine from b1ba9f329f76 to 322a461dc74f (2 revisions) (flutter/flutter#143123) 2024-02-07 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Improve build output for all platforms" (flutter/flutter#143125) 2024-02-07 [email protected] Roll Flutter Engine from e4a5acc14b44 to b1ba9f329f76 (2 revisions) (flutter/flutter#143120) 2024-02-07 [email protected] Improve build output for all platforms (flutter/flutter#128236) 2024-02-07 [email protected] Roll Flutter Engine from 19ae46afed69 to e4a5acc14b44 (7 revisions) (flutter/flutter#143112) 2024-02-07 [email protected] Fixed cursor blinking during selection. (flutter/flutter#141380) 2024-02-07 [email protected] Remove Cirrus check for web test concurrency (flutter/flutter#143046) 2024-02-07 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Enforce a policy on supported Gradle, Java, AGP, and KGP versions" (flutter/flutter#143114) 2024-02-07 [email protected] Enforce a policy on supported Gradle, Java, AGP, and KGP versions (flutter/flutter#142000) 2024-02-07 [email protected] Fix inputs and outputs for `WebReleaseBundle` (flutter/flutter#143023) 2024-02-07 [email protected] Various improvements to text-editing-related documentation. (flutter/flutter#142561) 2024-02-07 [email protected] Revert "Add `SingleChildScrollView` for `NavigationRail`" (flutter/flutter#143097) 2024-02-07 [email protected] Restore log dumps for gradle OOM crashes, and set a value for `MaxMetaspaceSize` (flutter/flutter#143085) 2024-02-07 [email protected] Move Mac_build_test flutter_gallery__transition_perf_e2e_ios out of staging (flutter/flutter#142987) 2024-02-07 [email protected] Roll Flutter Engine from fafd8e55eb4b to 19ae46afed69 (1 revision) (flutter/flutter#143094) 2024-02-07 [email protected] Add a test for the isAvailableForEnvironment logic (flutter/flutter#142251) 2024-02-07 [email protected] Add the number of mismatched pixels to golden tests output (flutter/flutter#142975) 2024-02-07 [email protected] Add indexInParent to SemanticsNode debug information (flutter/flutter#142826) 2024-02-07 [email protected] Remove unused devicelab task gradle_non_android_plugin_test (flutter/flutter#142742) 2024-02-07 [email protected] Make generate_gradle_lockfiles also write the gradle wrapper file (flutter/flutter#142329) 2024-02-07 [email protected] Roll Flutter Engine from 6807342305e4 to fafd8e55eb4b (1 revision) (flutter/flutter#143086) 2024-02-07 [email protected] Remove redundant `rootDirectoryPath` parameter in `DevFS::update` (flutter/flutter#143034) 2024-02-07 [email protected] Handle transitions to AppLifecycleState.detached in lifecycle state generation (flutter/flutter#142523) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: ...
No description provided.