[material_ui, cupertino_ui] Add linkToSource#11978
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 adds dartdoc_options.yaml files to configure source code linking for the cupertino_ui and material_ui packages, and adds comments to their respective pubspec.yaml files regarding version updates. Feedback points out that the uriTemplate in packages/material_ui/dartdoc_options.yaml incorrectly references the cupertino_ui directory instead of material_ui.
| dartdoc: | ||
| linkToSource: | ||
| root: '.' | ||
| uriTemplate: 'https://github.com/flutter/packages/blob/material_ui-v0.0.2/packages/cupertino_ui/%f%#L%l%' |
| @@ -1,6 +1,6 @@ | |||
| name: cupertino_ui | |||
| description: The official Flutter Cupertino Design Library, implementing the iOS design system. | |||
| version: 0.0.2 | |||
There was a problem hiding this comment.
@chunhtai does the batch release process bump the version? Will it need to handle this as well?
This PR adds the
linkToSourceoption todartdoc_options.yaml. This enables the "link to source" button in API docs, which is present in Flutter's doc.The catch is, while the URL format supports a
%r%parameter according todartdoc's Doc, it's not that useful. The revision parameter is often empty, which leads to crashes. In fact, thedartdocrepo themselves update the link manually: dart-lang/dartdoc@869c9ffPre-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