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.

Sign up for GitHub

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

Jump to bottom

Various improvements to text-editing-related documentation. #142561

Merged
merged 2 commits into from
Feb 7, 2024
Merged

Various improvements to text-editing-related documentation. #142561

merged 2 commits into from
Feb 7, 2024

Conversation

Hixie
Copy link
Contributor

@Hixie Hixie commented Jan 30, 2024

No description provided.

@github-actions github-actions bot added a: text input Entering text in a text field or keyboard related problems framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. f: cupertino flutter/packages/flutter/cupertino repository labels Jan 30, 2024
@Hixie Hixie marked this pull request as ready for review January 31, 2024 05:01
@justinmc justinmc self-requested a review February 1, 2024 23:12
justinmc
justinmc approved these changes Feb 2, 2024
View reviewed changes
Copy link
Contributor

@justinmc justinmc left a 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.

packages/flutter/lib/src/widgets/editable_text.dart
Comment on lines +1793 to +1794
/// [TextSelectionGestureDetectorBuilder.buildGestureDetector]. The widget
/// returned by [contextMenuBuilder] is passed to a [ContextMenuController].
Copy link
Contributor

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.

packages/flutter/lib/src/widgets/editable_text.dart
/// position for the context menu.
///
/// * [EditableTextState.contextMenuButtonItems] represents the buttons that
/// should typically be built for this widget (e.g. cut, copy, paste).
Copy link
Contributor

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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)

packages/flutter/lib/src/widgets/magnifier.dart
final MagnifierBuilder? _magnifierBuilder;

/// {@macro flutter.widgets.magnifier.MagnifierBuilder}
MagnifierBuilder get magnifierBuilder => _magnifierBuilder ?? (_, __, ___) => null;
Copy link
Contributor

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...

Copy link
Contributor Author

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

packages/flutter/lib/src/widgets/magnifier.dart
/// 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;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slick.

@Hixie Hixie added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 6, 2024
@auto-submit auto-submit bot merged commit 9fccb32 into flutter:master Feb 7, 2024
65 checks passed
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 8, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2024
@engine-flutter-autoroll
9fccb32a5 Various improvements to text-editing-related documentation. (…
7889997 
…flutter/flutter#142561)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 8, 2024
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 8, 2024
@engine-flutter-autoroll
9fccb32a5 Various improvements to text-editing-related documentation. (…
60862ed 
…flutter/flutter#142561)
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Feb 8, 2024
@engine-flutter-autoroll
Roll Flutter from 8431cae8843c to eb5d0a434ef1 (33 revisions) (#6079)
316bde0 
Roll Flutter from 8431cae8843c to eb5d0a434ef1 (33 revisions)

flutter/flutter@8431cae...eb5d0a4

2024-02-08 engine-flutter-autoroll@skia.org Roll Packages from e4ea6bf to 29d8cc0 (5 revisions) (flutter/flutter#143161)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 6d524588c0f9 to f53fbd8393ce (1 revision) (flutter/flutter#143160)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 22e1241e9823 to 6d524588c0f9 (3 revisions) (flutter/flutter#143147)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 084bd0b8f5ac to 22e1241e9823 (1 revision) (flutter/flutter#143140)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 104804aa374e to 084bd0b8f5ac (1 revision) (flutter/flutter#143139)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 45137ea6ba29 to 104804aa374e (1 revision) (flutter/flutter#143138)
2024-02-08 jacksongardner@google.com Pass along web renderer into debugging options in the test command. (flutter/flutter#143128)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4ea7bd07328b to 45137ea6ba29 (2 revisions) (flutter/flutter#143135)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 322a461dc74f to 4ea7bd07328b (2 revisions) (flutter/flutter#143131)
2024-02-07 36861262+QuncCccccc@users.noreply.github.com Add a unit test for `NavigationRail` (flutter/flutter#143108)
2024-02-07 engine-flutter-autoroll@skia.org 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 engine-flutter-autoroll@skia.org Roll Flutter Engine from e4a5acc14b44 to b1ba9f329f76 (2 revisions) (flutter/flutter#143120)
2024-02-07 6655696+guidezpl@users.noreply.github.com Improve build output for all platforms (flutter/flutter#128236)
2024-02-07 engine-flutter-autoroll@skia.org Roll Flutter Engine from 19ae46afed69 to e4a5acc14b44 (7 revisions) (flutter/flutter#143112)
2024-02-07 ybz975218925@gmail.com Fixed cursor blinking during selection. (flutter/flutter#141380)
2024-02-07 magder@google.com 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 34871572+gmackall@users.noreply.github.com Enforce a policy on supported Gradle, Java, AGP, and KGP versions (flutter/flutter#142000)
2024-02-07 jacksongardner@google.com Fix inputs and outputs for `WebReleaseBundle` (flutter/flutter#143023)
2024-02-07 ian@hixie.ch Various improvements to text-editing-related documentation. (flutter/flutter#142561)
2024-02-07 goderbauer@google.com Revert "Add `SingleChildScrollView` for `NavigationRail`" (flutter/flutter#143097)
2024-02-07 34871572+gmackall@users.noreply.github.com Restore log dumps for gradle OOM crashes, and set a value for `MaxMetaspaceSize` (flutter/flutter#143085)
2024-02-07 15619084+vashworth@users.noreply.github.com Move Mac_build_test flutter_gallery__transition_perf_e2e_ios out of staging (flutter/flutter#142987)
2024-02-07 engine-flutter-autoroll@skia.org Roll Flutter Engine from fafd8e55eb4b to 19ae46afed69 (1 revision) (flutter/flutter#143094)
2024-02-07 ian@hixie.ch Add a test for the isAvailableForEnvironment logic (flutter/flutter#142251)
2024-02-07 32538273+ValentinVignal@users.noreply.github.com Add the number of mismatched pixels to golden tests output (flutter/flutter#142975)
2024-02-07 goderbauer@google.com Add indexInParent to SemanticsNode debug information (flutter/flutter#142826)
2024-02-07 magder@google.com Remove unused devicelab task gradle_non_android_plugin_test (flutter/flutter#142742)
2024-02-07 34871572+gmackall@users.noreply.github.com Make generate_gradle_lockfiles also write the gradle wrapper file (flutter/flutter#142329)
2024-02-07 engine-flutter-autoroll@skia.org Roll Flutter Engine from 6807342305e4 to fafd8e55eb4b (1 revision) (flutter/flutter#143086)
2024-02-07 andrewrkolos@gmail.com Remove redundant `rootDirectoryPath` parameter in `DevFS::update` (flutter/flutter#143034)
2024-02-07 maRci002@users.noreply.github.com 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 rmistry@google.com,stuartmorgan@google.com,tarrinneal@google.com 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:
...
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 14, 2024
@engine-flutter-autoroll
9fccb32a5 Various improvements to text-editing-related documentation. (…
5144e34 
…flutter/flutter#142561)
arc-yong pushed a commit to Arctuition/packages-arc that referenced this pull request Jun 14, 2024
@engine-flutter-autoroll @arc-yong
Roll Flutter from 8431cae8843c to eb5d0a434ef1 (33 revisions) (flutte…
856c1d7 
…r#6079)

Roll Flutter from 8431cae8843c to eb5d0a434ef1 (33 revisions)

flutter/flutter@8431cae...eb5d0a4

2024-02-08 engine-flutter-autoroll@skia.org Roll Packages from e4ea6bf to 29d8cc0 (5 revisions) (flutter/flutter#143161)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 6d524588c0f9 to f53fbd8393ce (1 revision) (flutter/flutter#143160)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 22e1241e9823 to 6d524588c0f9 (3 revisions) (flutter/flutter#143147)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 084bd0b8f5ac to 22e1241e9823 (1 revision) (flutter/flutter#143140)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 104804aa374e to 084bd0b8f5ac (1 revision) (flutter/flutter#143139)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 45137ea6ba29 to 104804aa374e (1 revision) (flutter/flutter#143138)
2024-02-08 jacksongardner@google.com Pass along web renderer into debugging options in the test command. (flutter/flutter#143128)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4ea7bd07328b to 45137ea6ba29 (2 revisions) (flutter/flutter#143135)
2024-02-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 322a461dc74f to 4ea7bd07328b (2 revisions) (flutter/flutter#143131)
2024-02-07 36861262+QuncCccccc@users.noreply.github.com Add a unit test for `NavigationRail` (flutter/flutter#143108)
2024-02-07 engine-flutter-autoroll@skia.org 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 engine-flutter-autoroll@skia.org Roll Flutter Engine from e4a5acc14b44 to b1ba9f329f76 (2 revisions) (flutter/flutter#143120)
2024-02-07 6655696+guidezpl@users.noreply.github.com Improve build output for all platforms (flutter/flutter#128236)
2024-02-07 engine-flutter-autoroll@skia.org Roll Flutter Engine from 19ae46afed69 to e4a5acc14b44 (7 revisions) (flutter/flutter#143112)
2024-02-07 ybz975218925@gmail.com Fixed cursor blinking during selection. (flutter/flutter#141380)
2024-02-07 magder@google.com 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 34871572+gmackall@users.noreply.github.com Enforce a policy on supported Gradle, Java, AGP, and KGP versions (flutter/flutter#142000)
2024-02-07 jacksongardner@google.com Fix inputs and outputs for `WebReleaseBundle` (flutter/flutter#143023)
2024-02-07 ian@hixie.ch Various improvements to text-editing-related documentation. (flutter/flutter#142561)
2024-02-07 goderbauer@google.com Revert "Add `SingleChildScrollView` for `NavigationRail`" (flutter/flutter#143097)
2024-02-07 34871572+gmackall@users.noreply.github.com Restore log dumps for gradle OOM crashes, and set a value for `MaxMetaspaceSize` (flutter/flutter#143085)
2024-02-07 15619084+vashworth@users.noreply.github.com Move Mac_build_test flutter_gallery__transition_perf_e2e_ios out of staging (flutter/flutter#142987)
2024-02-07 engine-flutter-autoroll@skia.org Roll Flutter Engine from fafd8e55eb4b to 19ae46afed69 (1 revision) (flutter/flutter#143094)
2024-02-07 ian@hixie.ch Add a test for the isAvailableForEnvironment logic (flutter/flutter#142251)
2024-02-07 32538273+ValentinVignal@users.noreply.github.com Add the number of mismatched pixels to golden tests output (flutter/flutter#142975)
2024-02-07 goderbauer@google.com Add indexInParent to SemanticsNode debug information (flutter/flutter#142826)
2024-02-07 magder@google.com Remove unused devicelab task gradle_non_android_plugin_test (flutter/flutter#142742)
2024-02-07 34871572+gmackall@users.noreply.github.com Make generate_gradle_lockfiles also write the gradle wrapper file (flutter/flutter#142329)
2024-02-07 engine-flutter-autoroll@skia.org Roll Flutter Engine from 6807342305e4 to fafd8e55eb4b (1 revision) (flutter/flutter#143086)
2024-02-07 andrewrkolos@gmail.com Remove redundant `rootDirectoryPath` parameter in `DevFS::update` (flutter/flutter#143034)
2024-02-07 maRci002@users.noreply.github.com 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 rmistry@google.com,stuartmorgan@google.com,tarrinneal@google.com 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:
...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@justinmc justinmc justinmc approved these changes

Assignees
No one assigned
Labels
a: text input Entering text in a text field or keyboard related problems autosubmit Merge PR when tree becomes green via auto submit App f: cupertino flutter/packages/flutter/cupertino repository f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Hixie @justinmc