[material_ui, cupertino_ui] Fix API doc references#12274
Conversation
|
It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging. If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix? Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group. |
There was a problem hiding this comment.
Code Review
This pull request replaces documentation macros with inline documentation for scrollbars and primary scroll views, adds @docImport statements, and comments out {@youtube} directives. Feedback from the reviewer indicates that using // instead of /// to comment out the youtube directives breaks Dart's documentation comment blocks, detaching preceding documentation from their declarations. The reviewer suggests using /// and removing the @ symbol to keep the comment blocks contiguous.
| /// visible. | ||
| /// | ||
| /// {@macro flutter.widgets.Scrollbar} | ||
| /// By default, the thumb will fade in and out as the child scroll view |
There was a problem hiding this comment.
This change and alike duplicate with #12271 . While I'm leaning towards my approach, I'm ok with either, and let me know what you think.
There was a problem hiding this comment.
Gotcha gotcha, sorry I missed that. It has given me a new idea for the youtube ones too. I prefer your solution, I will revert those duped instances here.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request replaces the {@youtube} directive with standard text links to the Flutter YouTube channel across various Cupertino and Material widgets, and adds @docImport directives to several library files. Feedback on the changes identifies typos using four slashes (////) instead of three (///) for documentation comments in scrollbar.dart and reorderable_list.dart. Additionally, incorrect widget references were noted in the documentation comments for sheet.dart and scaffold.dart.
|
autosubmit label was removed for flutter/packages/12274, because - The status or check suite Dashboard Checks has failed. Please fix the issues identified (or deflake) before re-applying this label. |
|
Oo interesting scenario here. We enabled batch release for these packages, and removed the publish_to: none, but now we're failing repo checks for not bumping the version. @justinmc do you know the right steps to land things now? |
Fix doc references in material_ui and cupertino_ui
Towards flutter/flutter#189629
I also commented out youtube directives since they do not work outside of the SDK.
There are some references we cannot fix in the design packages themselves, largely due tot he fact that material_ui and cupertino_ui export the widgets library. That pulls in doc references from the widgets library that cannot be resolved outside of the scope of the SDK.
We can change the doc upstream in the SDK, but that feel like a poor choice to make the docs less helpful in the SDK in order to resolve a reference issue in a downstream package.
Something we are planning for after the initial 1.0 is to remove the export of widgets from both packages, which will resolve the remaining issues.
Pre-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