[material_ui, cupertino_ui] Migrate dartpad TODOs to <callout-box>#12120
[material_ui, cupertino_ui] Migrate dartpad TODOs to <callout-box>#12120dkwingsmt wants to merge 8 commits into
<callout-box>#12120Conversation
|
Warning Gemini encountered an error creating the review. You can try again by commenting |
|
/gemini review |
There was a problem hiding this comment.
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.
|
FYI this PR is now ready for review. |
Piinks
left a comment
There was a problem hiding this comment.
Are the packages in this repo using Dartdoc 9.0.7?
LGTM
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:This PR also disables
unintended_html_in_doc_commentbecause<callout-box>is not recognized by the linter for now. An issue has been filed: dart-lang/sdk#63782Pre-Review Checklist
[shared_preferences]///).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-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.Footnotes
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