Skip to content

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

Open
dkwingsmt wants to merge 8 commits into
flutter:mainfrom
dkwingsmt:migrate-dartpad-to-callout-box
Open

[material_ui, cupertino_ui] Migrate dartpad TODOs to <callout-box>#12120
dkwingsmt wants to merge 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#63777

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

1 participant