[material_ui, cupertino_ui] Migrate snippet TODOs to <callout-box>#12146
Open
dkwingsmt wants to merge 4 commits into
Open
[material_ui, cupertino_ui] Migrate snippet TODOs to <callout-box>#12146dkwingsmt wants to merge 4 commits into
<callout-box>#12146dkwingsmt wants to merge 4 commits into
Conversation
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: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