Skip to content

[material_ui, cupertino_ui] Migrate dartpad TODOs to <callout-box> - #12120

Merged
auto-submit[bot] merged 8 commits into
flutter:mainfrom
dkwingsmt:migrate-dartpad-to-callout-box
Jul 9, 2026
Merged

auto-submit[bot] merged 8 commits into
flutter:mainfrom
dkwingsmt:migrate-dartpad-to-callout-box

Conversation

@dkwingsmt

@dkwingsmt dkwingsmt commented Jul 6, 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 should-be Dartpad 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

@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label Jul 6, 2026
@github-actions github-actions Bot added triage-framework Should be looked at in framework triage p: cupertino_ui p: material_ui labels Jul 6, 2026
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

@github-actions github-actions Bot removed the CICD Run CI/CD label Jul 7, 2026
@dkwingsmt

Copy link
Copy Markdown
Contributor Author

/gemini review

@dkwingsmt dkwingsmt added the CICD Run CI/CD label Jul 7, 2026

@gemini-code-assist gemini-code-assist Bot 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 wraps example documentation blocks in tags across multiple Cupertino and Material UI components, and disables the unintended_html_in_doc_comment linter rule. Feedback on the changes highlights that placing regular // TODO comments inside contiguous /// doc comment blocks terminates the block, causing dartdoc to ignore the preceding documentation. The reviewer suggests moving these // TODO comments outside of the doc comment blocks to ensure correct API documentation generation.

Comment thread packages/cupertino_ui/lib/src/activity_indicator.dart
Comment thread packages/cupertino_ui/lib/src/bottom_tab_bar.dart
Comment thread packages/cupertino_ui/lib/src/button.dart
Comment thread packages/cupertino_ui/lib/src/dialog.dart
@Piinks
Piinks requested review from Piinks and loic-sharma July 7, 2026 22:12
@github-actions github-actions Bot removed the CICD Run CI/CD label Jul 7, 2026
@dkwingsmt dkwingsmt added the CICD Run CI/CD label Jul 7, 2026
@dkwingsmt

Copy link
Copy Markdown
Contributor Author

FYI this PR is now ready for review.

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

Are the packages in this repo using Dartdoc 9.0.7?

LGTM

@dkwingsmt dkwingsmt added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 9, 2026
@dkwingsmt

Copy link
Copy Markdown
Contributor Author

Yes. New dartdoc versions are applied to new package releases automatically.

@auto-submit
auto-submit Bot merged commit 16204fd into flutter:main Jul 9, 2026
88 checks passed
@dkwingsmt
dkwingsmt deleted the migrate-dartpad-to-callout-box branch July 9, 2026 23:20
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
Rusino pushed a commit to Rusino/flutter that referenced this pull request Sep 24, 2026
…es, and migrate some `@tool` directives (flutter#189670)

This PR consists of two parts of changes.

## Migrate some `@tool` directives

As part of flutter#189629, this PR
migrates specific templates used by the `material_ui` and `cupertino_ui`
packages from `{@tool}` directives to standard dartdoc to ensure they
render correctly within these packages. This migration is limited to
only these essential `{@tool}` instances, as Dartdoc does not currently
provide native support for Dartpad.

Note that Dartpad notices ("_To see it in action, copy and run this code
snippet on Dartpad_") are expanded, unlike in
flutter/packages#12120 where they're macros.
This is necessary because Dartdoc can't correctly handle nested
templates and macros, preventing inner macros from expanding correctly.

This PR will be followed by reverting
flutter/packages#12271, which constitutes the
final step of flutter#189629. I have
verified that the package docs will render correctly after the revert.

## Make `check_code_samples.dart‎` support the standard example
directives

Since the examples now consist of two styles, the legacy style "See code
in" and the standard style `@example`,
`check_code_samples.dart‎` needs to be updated to recognize the standard
`@example` directives so that it won't incorrectly report that these
examples files are not used by any docs.

## Pre-launch Checklist

- [ ] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [ ] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [ ] 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.

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](https://developers.google.com/gemini-code-assist/docs/review-github-code).
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.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[AI contribution guidelines]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
[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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App CICD Run CI/CD p: cupertino_ui p: material_ui triage-framework Should be looked at in framework triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants