Skip to content

[material_ui, cupertino_ui] Migrate snippet TODOs to <callout-box> - #12146

Merged
auto-submit[bot] merged 4 commits into
flutter:mainfrom
dkwingsmt:migrate-snippet
Jul 11, 2026
Merged

[material_ui, cupertino_ui] Migrate snippet TODOs to <callout-box>#12146
auto-submit[bot] merged 4 commits into
flutter:mainfrom
dkwingsmt:migrate-snippet

Conversation

@dkwingsmt

@dkwingsmtdkwingsmt commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Background

Dartdoc 9.0.7 added support for <callout-box> (what we used to call the blue container).

What's changed

This PR migrates all former snippet instances in API docs to <callout-box>. This is what it looks like:

image

This PR also disables unintended_html_in_doc_comment because <callout-box> is not recognized by the linter for now. An issue has been filed: dart-lang/sdk#63782

Pre-Review Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot 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.

Footnotes

  1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. 2

@github-actionsgithub-actionsBot added triage-framework Should be looked at in framework triage p: cupertino_ui p: material_ui labels Jul 8, 2026
@flutter-dashboardflutter-dashboardBot added the CICD Run CI/CD label Jul 8, 2026
@github-actionsgithub-actionsBot removed the CICD Run CI/CD label Jul 8, 2026

@gemini-code-assistgemini-code-assistBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request replaces placeholder TODO comments for blue example containers with <callout-box> and </callout-box> tags in the documentation comments across numerous Cupertino and Material UI files. The review feedback suggests adding an empty doc comment line (///) between consecutive closing and opening callout box tags in colors.dart, ink_decoration.dart, and list_tile.dart to ensure consistent formatting and correct markdown parsing.

Comment threadpackages/material_ui/lib/src/colors.dart
Comment threadpackages/material_ui/lib/src/ink_decoration.dart
Comment threadpackages/material_ui/lib/src/list_tile.dart
@dkwingsmtdkwingsmt added the CICD Run CI/CD label Jul 8, 2026

@justinmcjustinmc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 👍

Comment on lines +19 to +20
# TODO(dkwingsmt): Remove when https://github.com/dart-lang/sdk/issues/63777 is fixed.
unintended_html_in_doc_comment: false

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I guess this is better than doing this everywhere:

/// <callout-box> // ignore: unintended_html_in_doc_comment

@PiinksPiinks left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM as well!

@dkwingsmtdkwingsmt added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 10, 2026
@auto-submit
auto-submitBot merged commit 3678ba5 into flutter:mainJul 11, 2026
89 checks passed
loic-sharma pushed a commit to ishaquehassan/flutter that referenced this pull request Jul 13, 2026
…er#189387)
flutter/packages@20928d5...ad2eab1
2026-07-13 35750184+motucraft@users.noreply.github.com [camera] Guard
CameraController value updates after dispose (flutter/packages#11861)
2026-07-13 dkwingsmt@users.noreply.github.com [material_ui] Remove
unused example files (flutter/packages#12179)
2026-07-13 puneetkukreja98@gmail.com
[google_maps_flutter_platform_interface] Adds support for
mapTypeControlEnabled, fullscreenControlEnabled, and
streetViewControlEnabled for web (flutter/packages#12191)
2026-07-13 44747303+theprantadutta@users.noreply.github.com [pigeon]
Report a clear error for enhanced enums (flutter/packages#11880)
2026-07-13 49699333+dependabot[bot]@users.noreply.github.com Bump
actions/labeler from 6.1.0 to 6.2.0 in the all-github-actions group
(flutter/packages#12190)
2026-07-13 stuartmorgan@google.com [shared_preferences] Convert legacy
codepath to Kotlin (flutter/packages#12139)
2026-07-12 engine-flutter-autoroll@skia.org Roll Flutter from
f7b66f3 to cf9e8af (11 revisions) (flutter/packages#12188)
2026-07-11 44525804+sailendrabathi@users.noreply.github.com
[video_player] Improve seek performance on Android
(flutter/packages#11810)
2026-07-11 stuartmorgan@google.com [pigeon] Disable iOS test
parallelization (flutter/packages#12177)
2026-07-11 dkwingsmt@users.noreply.github.com [material_ui,
cupertino_ui] Migrate snippet TODOs to `<callout-box>`
(flutter/packages#12146)
2026-07-11 dkwingsmt@users.noreply.github.com [cupertino_ui] Fix example
path (flutter/packages#12151)
2026-07-10 engine-flutter-autoroll@skia.org Roll Flutter from
dc2a870 to f7b66f3 (12 revisions) (flutter/packages#12175)
2026-07-10 engine-flutter-autoroll@skia.org Roll Flutter (stable) from
f94f4fc to ee80f08 (3 revisions) (flutter/packages#12171)
2026-07-10 engine-flutter-autoroll@skia.org Manual roll Flutter from
91939cc to dc2a870 (50 revisions) (flutter/packages#12169)
2026-07-09 jessiewong401@gmail.com Update `legacy` test to be in Warn
Range (flutter/packages#12168)
2026-07-09 dkwingsmt@users.noreply.github.com [material_ui,
cupertino_ui] Migrate dartpad TODOs to `<callout-box>`
(flutter/packages#12120)
2026-07-09 73310711+shrabanti722@users.noreply.github.com
[video_player_avfoundation] Implement
preventsDisplaySleepDuringVideoPlayback (flutter/packages#11547)
2026-07-09 44747303+theprantadutta@users.noreply.github.com [pigeon] Add
usage docs to generated Dart event channel methods
(flutter/packages#11894)
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-flutter-autoroll
Please CC flutter-ecosystem@google.com on the revert to ensure that a
human
is aware of the problem.
To file a bug in Flutter:
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:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmitMerge PR when tree becomes green via auto submit AppCICDRun CI/CDp: cupertino_uip: material_uitriage-frameworkShould be looked at in framework triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@dkwingsmt@justinmc@Piinks