Fix documentation of Flow.clipBehavior #161863

mernen · 2025-01-18T19:36:58Z

The documentation described the default value as Clip.none, but both constructors actually default to Clip.hardEdge.

(I considered this to be a trivial documentation change, so no issue was filed.)

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

Adjusted to reflect the true default value in the constructors.

piedcipher

Thanks for catching this. LGTM

goderbauer

LGTM

Manual roll Flutter from b9e86a5 to b2f515f (42 revisions) Manual roll requested by tarrinneal@google.com flutter/flutter@b9e86a5...b2f515f 2025-01-22 a-siva@users.noreply.github.com Roll Dart to Version 3.8.0-24.0.dev (flutter/flutter#162035) 2025-01-22 nate.w5687@gmail.com `const AnimationStyle` (flutter/flutter#160564) 2025-01-22 matanlurey@users.noreply.github.com Add piping and bringup nodes for `_vulkan` and `_opengles` suites. (flutter/flutter#162020) 2025-01-22 flar@google.com [Impeller] Migrate unit tests off of Skia geometry classes (flutter/flutter#161855) 2025-01-22 matanlurey@users.noreply.github.com Experiment with a `files-changed.json` per PR (flutter/flutter#161788) 2025-01-22 robert.ancell@canonical.com Move FlKeyboardManager and FlKeyboardHandler from FlView to FlEngine. (flutter/flutter#161925) 2025-01-22 engine-flutter-autoroll@skia.org Roll Packages from e8f1f63 to 3d3ab7b (1 revision) (flutter/flutter#162019) 2025-01-22 47866232+chunhtai@users.noreply.github.com Adds cupertino picker semantics test (flutter/flutter#161768) 2025-01-22 mdebbar@google.com [web] Remove deprecated web-only APIs from dart:ui (flutter/flutter#161775) 2025-01-22 34465683+rkishan516@users.noreply.github.com fix: Add enabled property for search anchor named constructor (flutter/flutter#161468) 2025-01-22 137456488+flutter-pub-roller-bot@users.noreply.github.com Roll pub packages (flutter/flutter#162015) 2025-01-22 mdebbar@google.com [web] Remove spam from test output (flutter/flutter#161774) 2025-01-22 43089218+chika3742@users.noreply.github.com Match CupertinoPageTransitionsBuilder animation duration to CupertinoPageRoute (2) (flutter/flutter#161577) 2025-01-22 matanlurey@users.noreply.github.com Make `font-subset` a standalone `run_tests.py` variant. (flutter/flutter#162016) 2025-01-22 kczarnota7@gmail.com Enabled provisioning updates and device registration during building xcarchive. (flutter/flutter#159622) 2025-01-22 mdebbar@google.com [web] Remove HTML from bots, test suites and e2e tests (flutter/flutter#161537) 2025-01-22 matanlurey@users.noreply.github.com Expand the `.ci.yaml` and `builder.json` linter (flutter/flutter#161991) 2025-01-22 37592940+sethmfuller@users.noreply.github.com Fix incorrect [enabled] documentation (flutter/flutter#161650) 2025-01-22 matanlurey@users.noreply.github.com Add `windows_host_engine_test`. (flutter/flutter#161992) 2025-01-22 a-siva@users.noreply.github.com Roll Dart to version Version 3.8.0-19.0.dev (flutter/flutter#161989) 2025-01-22 tessertaha@gmail.com Deprecate `ThemeData.indicatorColor` in favor of `TabBarThemeData.indicatorColor` (flutter/flutter#160024) 2025-01-22 jonahwilliams@google.com [Impeller] disable older xclipse gpu driver. (flutter/flutter#161981) 2025-01-22 jacksongardner@google.com Merge changelog for 3.27.3 release (flutter/flutter#161977) 2025-01-21 robert.ancell@canonical.com Remove FlKeyboardViewDelegate (flutter/flutter#161705) 2025-01-21 mernen@users.noreply.github.com Fix documentation of Flow.clipBehavior (flutter/flutter#161863) 2025-01-21 jonahwilliams@google.com [impeller] prevent PowerVR from using Vulkan backend. (flutter/flutter#161841) 2025-01-21 30870216+gaaclarke@users.noreply.github.com [Impeller] backfilling TextContents unit tests (flutter/flutter#161625) 2025-01-21 jason-simmons@users.noreply.github.com Do not handle Dart isolate messages if the isolate is being shut down (flutter/flutter#161824) 2025-01-21 mohellebiabdessalem@gmail.com fix failing lint : findByPath requires a specific ordering of project evaluation in `aar_init_script.gradle` (flutter/flutter#159301) 2025-01-21 jacksongardner@google.com Get `et` working for local web engine builds. (flutter/flutter#161825) 2025-01-21 magder@google.com Mark Linux_pixel_7pro flavors_test unflaky (flutter/flutter#160994) 2025-01-21 fluttergithubbot@gmail.com Marks Mac_mokey run_debug_test_android to be flaky (flutter/flutter#161656) 2025-01-21 saltedpotatos@users.noreply.github.com Don't crash flutter tool if Chrome is not available (flutter/flutter#154941) 2025-01-21 bruno.leroux@gmail.com Fix DropdownMenu icon and item icon misalignment (flutter/flutter#161717) 2025-01-21 dacoharkes@google.com [native assets] Cleanup dead code 2 (flutter/flutter#161916) 2025-01-21 tessertaha@gmail.com Update `ListTile` test to prevent log dump and test error message. (flutter/flutter#161811) 2025-01-21 137456488+flutter-pub-roller-bot@users.noreply.github.com Roll pub packages (flutter/flutter#161924) 2025-01-21 31859944+LongCatIsLooong@users.noreply.github.com Make `PipelineOwner` a `base` class (flutter/flutter#161789) 2025-01-20 dacoharkes@google.com [native assets] Cleanup dead code (flutter/flutter#161913) 2025-01-20 engine-flutter-autoroll@skia.org Roll Packages from f73cb00 to e8f1f63 (9 revisions) (flutter/flutter#161914) 2025-01-20 bkonyi@google.com [ flutter_tool ] Fix flakiness in doctor_test.dart (flutter/flutter#161917) 2025-01-19 robert.ancell@canonical.com Update documentation on what display information is provided. (flutter/flutter#161785) If this roll has caused a breakage, revert this CL and stop the roller ...

The documentation described the default value as `Clip.none`, but both constructors actually default to `Clip.hardEdge`. (I considered this to be a trivial documentation change, so no issue was filed.) ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [ ] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing.  [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

) Manual roll Flutter from b9e86a5 to b2f515f (42 revisions) Manual roll requested by tarrinneal@google.com flutter/flutter@b9e86a5...b2f515f 2025-01-22 a-siva@users.noreply.github.com Roll Dart to Version 3.8.0-24.0.dev (flutter/flutter#162035) 2025-01-22 nate.w5687@gmail.com `const AnimationStyle` (flutter/flutter#160564) 2025-01-22 matanlurey@users.noreply.github.com Add piping and bringup nodes for `_vulkan` and `_opengles` suites. (flutter/flutter#162020) 2025-01-22 flar@google.com [Impeller] Migrate unit tests off of Skia geometry classes (flutter/flutter#161855) 2025-01-22 matanlurey@users.noreply.github.com Experiment with a `files-changed.json` per PR (flutter/flutter#161788) 2025-01-22 robert.ancell@canonical.com Move FlKeyboardManager and FlKeyboardHandler from FlView to FlEngine. (flutter/flutter#161925) 2025-01-22 engine-flutter-autoroll@skia.org Roll Packages from e8f1f63 to 3d3ab7b (1 revision) (flutter/flutter#162019) 2025-01-22 47866232+chunhtai@users.noreply.github.com Adds cupertino picker semantics test (flutter/flutter#161768) 2025-01-22 mdebbar@google.com [web] Remove deprecated web-only APIs from dart:ui (flutter/flutter#161775) 2025-01-22 34465683+rkishan516@users.noreply.github.com fix: Add enabled property for search anchor named constructor (flutter/flutter#161468) 2025-01-22 137456488+flutter-pub-roller-bot@users.noreply.github.com Roll pub packages (flutter/flutter#162015) 2025-01-22 mdebbar@google.com [web] Remove spam from test output (flutter/flutter#161774) 2025-01-22 43089218+chika3742@users.noreply.github.com Match CupertinoPageTransitionsBuilder animation duration to CupertinoPageRoute (2) (flutter/flutter#161577) 2025-01-22 matanlurey@users.noreply.github.com Make `font-subset` a standalone `run_tests.py` variant. (flutter/flutter#162016) 2025-01-22 kczarnota7@gmail.com Enabled provisioning updates and device registration during building xcarchive. (flutter/flutter#159622) 2025-01-22 mdebbar@google.com [web] Remove HTML from bots, test suites and e2e tests (flutter/flutter#161537) 2025-01-22 matanlurey@users.noreply.github.com Expand the `.ci.yaml` and `builder.json` linter (flutter/flutter#161991) 2025-01-22 37592940+sethmfuller@users.noreply.github.com Fix incorrect [enabled] documentation (flutter/flutter#161650) 2025-01-22 matanlurey@users.noreply.github.com Add `windows_host_engine_test`. (flutter/flutter#161992) 2025-01-22 a-siva@users.noreply.github.com Roll Dart to version Version 3.8.0-19.0.dev (flutter/flutter#161989) 2025-01-22 tessertaha@gmail.com Deprecate `ThemeData.indicatorColor` in favor of `TabBarThemeData.indicatorColor` (flutter/flutter#160024) 2025-01-22 jonahwilliams@google.com [Impeller] disable older xclipse gpu driver. (flutter/flutter#161981) 2025-01-22 jacksongardner@google.com Merge changelog for 3.27.3 release (flutter/flutter#161977) 2025-01-21 robert.ancell@canonical.com Remove FlKeyboardViewDelegate (flutter/flutter#161705) 2025-01-21 mernen@users.noreply.github.com Fix documentation of Flow.clipBehavior (flutter/flutter#161863) 2025-01-21 jonahwilliams@google.com [impeller] prevent PowerVR from using Vulkan backend. (flutter/flutter#161841) 2025-01-21 30870216+gaaclarke@users.noreply.github.com [Impeller] backfilling TextContents unit tests (flutter/flutter#161625) 2025-01-21 jason-simmons@users.noreply.github.com Do not handle Dart isolate messages if the isolate is being shut down (flutter/flutter#161824) 2025-01-21 mohellebiabdessalem@gmail.com fix failing lint : findByPath requires a specific ordering of project evaluation in `aar_init_script.gradle` (flutter/flutter#159301) 2025-01-21 jacksongardner@google.com Get `et` working for local web engine builds. (flutter/flutter#161825) 2025-01-21 magder@google.com Mark Linux_pixel_7pro flavors_test unflaky (flutter/flutter#160994) 2025-01-21 fluttergithubbot@gmail.com Marks Mac_mokey run_debug_test_android to be flaky (flutter/flutter#161656) 2025-01-21 saltedpotatos@users.noreply.github.com Don't crash flutter tool if Chrome is not available (flutter/flutter#154941) 2025-01-21 bruno.leroux@gmail.com Fix DropdownMenu icon and item icon misalignment (flutter/flutter#161717) 2025-01-21 dacoharkes@google.com [native assets] Cleanup dead code 2 (flutter/flutter#161916) 2025-01-21 tessertaha@gmail.com Update `ListTile` test to prevent log dump and test error message. (flutter/flutter#161811) 2025-01-21 137456488+flutter-pub-roller-bot@users.noreply.github.com Roll pub packages (flutter/flutter#161924) 2025-01-21 31859944+LongCatIsLooong@users.noreply.github.com Make `PipelineOwner` a `base` class (flutter/flutter#161789) 2025-01-20 dacoharkes@google.com [native assets] Cleanup dead code (flutter/flutter#161913) 2025-01-20 engine-flutter-autoroll@skia.org Roll Packages from f73cb00 to e8f1f63 (9 revisions) (flutter/flutter#161914) 2025-01-20 bkonyi@google.com [ flutter_tool ] Fix flakiness in doctor_test.dart (flutter/flutter#161917) 2025-01-19 robert.ancell@canonical.com Update documentation on what display information is provided. (flutter/flutter#161785) If this roll has caused a breakage, revert this CL and stop the roller ...

Fix documentation of Flow.clipBehavior

5ca5378

Adjusted to reflect the true default value in the constructors.

github-actions bot added the framework flutter/packages/flutter repository. See also f: labels. label Jan 18, 2025

piedcipher approved these changes Jan 20, 2025

View reviewed changes

goderbauer approved these changes Jan 21, 2025

View reviewed changes

goderbauer added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 21, 2025

auto-submit bot added this pull request to the merge queue Jan 21, 2025

Merged via the queue into flutter:master with commit d35626d Jan 21, 2025
104 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 21, 2025

engine-flutter-autoroll mentioned this pull request Jan 22, 2025

Roll Flutter from b9e86a565f92 to 9adbc51a80b0 (22 revisions) flutter/packages#8477

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 22, 2025

d35626d Fix documentation of Flow.clipBehavior (flutter/flutter#161863)

2bbdbd3

engine-flutter-autoroll mentioned this pull request Jan 22, 2025

Roll Flutter from b9e86a565f92 to a17128274d34 (23 revisions) flutter/packages#8480

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 22, 2025

d35626d Fix documentation of Flow.clipBehavior (flutter/flutter#161863)

afd50bb

engine-flutter-autoroll mentioned this pull request Jan 22, 2025

Manual roll Flutter from b9e86a565f92 to b2f515f45ef5 (42 revisions) flutter/packages#8482

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 22, 2025

d35626d Fix documentation of Flow.clipBehavior (flutter/flutter#161863)

07e2009

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

d35626d Fix documentation of Flow.clipBehavior (flutter/flutter#161863)

544ff43

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 20, 2025

d35626d Fix documentation of Flow.clipBehavior (flutter/flutter#161863)

7d51257

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 21, 2025

d35626d Fix documentation of Flow.clipBehavior (flutter/flutter#161863)

c31e677

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix documentation of Flow.clipBehavior #161863

Fix documentation of Flow.clipBehavior #161863

Uh oh!

mernen commented Jan 18, 2025

Uh oh!

piedcipher left a comment

Uh oh!

goderbauer left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix documentation of Flow.clipBehavior #161863

Fix documentation of Flow.clipBehavior #161863

Uh oh!

Conversation

mernen commented Jan 18, 2025

Pre-launch Checklist

Uh oh!

piedcipher left a comment

Choose a reason for hiding this comment

Uh oh!

goderbauer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants