Repository navigation
Removes reference to unnecessary ensureSemantics call in doc - #195831
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in packages/flutter_test to reflect that testWidgets enables semantics by default, removing manual SemanticsHandle setup and disposal from several sample code blocks. The feedback recommends replacing backticks with square brackets (e.g., [testWidgets]) in the documentation comments to allow dartdoc to generate hyperlinks, as per Effective Dart guidelines.
| /// To retrieve the semantics data of a widget, use [SemanticsController.find] | ||
| /// with a [FinderBase] that returns a single widget. Semantics must be enabled | ||
| /// in order to use this method. | ||
| /// in order to use this method; `testWidgets` enables semantics by default. |
There was a problem hiding this comment.
In Dart documentation comments, prefer referencing other API members (like testWidgets) using square brackets (e.g., [testWidgets]) instead of backticks. This enables dartdoc to automatically generate a hyperlink to the referenced function's documentation.
/// in order to use this method; [testWidgets] enables semantics by default.References
- Effective Dart: Documentation recommends referencing members in square brackets to generate hyperlinks. (link)
| /// To retrieve the semantics data of a widget, use [SemanticsController.find] | ||
| /// with a [FinderBase] that returns a single widget. Semantics must be enabled | ||
| /// in order to use this method. | ||
| /// in order to use this method; `testWidgets` enables semantics by default. |
There was a problem hiding this comment.
In Dart documentation comments, prefer referencing other API members (like testWidgets) using square brackets (e.g., [testWidgets]) instead of backticks. This enables dartdoc to automatically generate a hyperlink to the referenced function's documentation.
/// in order to use this method; [testWidgets] enables semantics by default.References
- Effective Dart: Documentation recommends referencing members in square brackets to generate hyperlinks. (link)
| /// To retrieve the semantics data of a widget, use [SemanticsController.find] | ||
| /// with a [FinderBase] that returns a single widget. Semantics must be enabled | ||
| /// in order to use this method. | ||
| /// in order to use this method; `testWidgets` enables semantics by default. |
There was a problem hiding this comment.
In Dart documentation comments, prefer referencing other API members (like testWidgets) using square brackets (e.g., [testWidgets]) instead of backticks. This enables dartdoc to automatically generate a hyperlink to the referenced function's documentation.
/// in order to use this method; [testWidgets] enables semantics by default.References
- Effective Dart: Documentation recommends referencing members in square brackets to generate hyperlinks. (link)
| /// | ||
| /// This matcher requires the result to be awaited and for semantics to be | ||
| /// enabled first. | ||
| /// enabled first. `testWidgets` enables semantics by default. |
There was a problem hiding this comment.
In Dart documentation comments, prefer referencing other API members (like testWidgets) using square brackets (e.g., [testWidgets]) instead of backticks. This enables dartdoc to automatically generate a hyperlink to the referenced function's documentation.
/// enabled first. [testWidgets] enables semantics by default.References
- Effective Dart: Documentation recommends referencing members in square brackets to generate hyperlinks. (link)
|
It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging. If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix? Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If both you and the PR author believe this PR qualifies for a test exemption, escalate to the tech lead for the changed area to review and apply the |
|
Test exemption reason: Documentation improvement with no behavioral changes. |
|
autosubmit label was removed for flutter/flutter/195831, because The base commit of the PR is older than 7 days and can not be merged. Please merge the latest changes from the main into this branch and resubmit the PR. |
|
autosubmit label was removed for flutter/flutter/195831, because - The status or check suite Presubmit has failed. Please fix the issues identified (or deflake) before re-applying this label. |
…13653) Manual roll Flutter from 9c427b5d7b1c to 1b9585481095 (32 revisions) Manual roll requested by [email protected] flutter/flutter@9c427b5...1b95854 2026-11-13 [email protected] Roll pub packages (flutter/flutter#196541) 2026-11-13 [email protected] Do not route PRs for review without cla, convert to draft (flutter/flutter#196341) 2026-11-13 [email protected] Roll Skia from d87a6c04da74 to 11f46cfe8838 (13 revisions) (flutter/flutter#196533) 2026-11-13 [email protected] [flutter_tools, flutter_test] Deprecate --experimental-faster-testing (flutter/flutter#196123) 2026-11-13 [email protected] [flutter_tools] Handle RPCError in ScreenshotCommand.runSkia (flutter/flutter#196132) 2026-11-13 [email protected] Roll Dart SDK from a8b961fd48bb to c91e8b6674e2 (2 revisions) (flutter/flutter#196502) 2026-11-13 [email protected] Roll Skia from 0c5ce4960cef to d87a6c04da74 (12 revisions) (flutter/flutter#196497) 2026-11-13 [email protected] Don't call `skia_image()` for raster-owned images in `DlImage::Equals` (flutter/flutter#196473) 2026-11-13 [email protected] [flutter_tools] Require FlutterCommandRunner DI fields and extract findCommandName (flutter/flutter#196331) 2026-11-13 [email protected] [web] Unify ui.Canvas behind a shared EngineCanvas frontend (flutter/flutter#196348) 2026-11-13 [email protected] Link to MediaQuery.displayFeaturesOf from DisplayFeatures (flutter/flutter#193728) 2026-11-13 [email protected] Removes reference to unnecessary ensureSemantics call in doc (flutter/flutter#195831) 2026-11-13 [email protected] [flutter_tools] Register trackWidgetCreation in AppleBuildOptionsBundle (flutter/flutter#196078) 2026-11-12 [email protected] [Android] Skip the HardwareBuffer defect fallback for platform views (flutter/flutter#193441) 2026-11-12 [email protected] Fix supports_decal check in framebuffer_blend.frag (flutter/flutter#196227) 2026-11-12 [email protected] [ios] Update the screen in didUpdateEffectiveGeometry (flutter/flutter#195508) 2026-11-12 [email protected] [flutter_tools] Add `Cache-Control` headers for web test assets (flutter/flutter#196414) 2026-11-12 [email protected] Roll Skia from 3b71ec08218f to 0c5ce4960cef (16 revisions) (flutter/flutter#196472) 2026-11-12 [email protected] [web] Render bounded ImageFilter.blur on wimp (flutter/flutter#196081) 2026-11-12 [email protected] Roll Dart SDK from 69567bd3c427 to a8b961fd48bb (2 revisions) (flutter/flutter#196464) 2026-11-12 [email protected] [engine] Release the Skia OpenGL resource context on shutdown (flutter/flutter#193592) 2026-11-12 [email protected] [web] Fix decoding of still AVIF images on Chrome (flutter/flutter#195958) 2026-11-12 [email protected] Gate SurfaceControl context setting on API 34+ (flutter/flutter#196394) 2026-11-12 [email protected] [flutter_tools] Only pass on a valid root tool in DASH__TOOL (flutter/flutter#196228) 2026-11-12 [email protected] Support GL_TEXTURE_EXTERNAL_OES embedder textures in Impeller (flutter/flutter#195857) 2026-11-12 [email protected] Stop building linux/wasm_release in local_engine_builds (flutter/flutter#196345) 2026-11-12 [email protected] Split flame out of Linux customer_testing (flutter/flutter#196347) 2026-11-12 Jiwon Lee [Windows] Fix Space input after Alt+Space with previous Microsoft IME (flutter/flutter#192105) 2026-11-12 [email protected] [flutter_tools] Add ToolExtensionException, exit() guard, graceful shutdown, and base modifiers (flutter/flutter#195908) 2026-11-12 [email protected] Roll Packages from 653628e to 14f9933 (9 revisions) (flutter/flutter#196450) 2026-11-12 [email protected] Roll Dart SDK from e5add7a25b32 to 69567bd3c427 (2 revisions) (flutter/flutter#196437) 2026-11-12 [email protected] Roll Skia from 9aa2513a4ac9 to 3b71ec08218f (1 revision) (flutter/flutter#196436) If this roll has caused a breakage, revert this CL and set the roller to dry run mode using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [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 ...
to avoid agent keep adding unnecessary ensuresemantics
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.