Skip to content

[material_ui, cupertino_ui] Add linkToSource#11978

Open
dkwingsmt wants to merge 1 commit into
flutter:mainfrom
dkwingsmt:link-to-source
Open

[material_ui, cupertino_ui] Add linkToSource#11978
dkwingsmt wants to merge 1 commit into
flutter:mainfrom
dkwingsmt:link-to-source

Conversation

@dkwingsmt

Copy link
Copy Markdown
Contributor

This PR adds the linkToSource option to dartdoc_options.yaml. This enables the "link to source" button in API docs, which is present in Flutter's doc.

Screenshot 2026-06-24 at 5 29 30 PM

The catch is, while the URL format supports a %r% parameter according to dartdoc's Doc, it's not that useful. The revision parameter is often empty, which leads to crashes. In fact, the dartdoc repo themselves update the link manually: dart-lang/dartdoc@869c9ff

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 Jun 25, 2026
@flutter-dashboard

Copy link
Copy Markdown

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.

@github-actions github-actions Bot added triage-framework Should be looked at in framework triage p: material_ui labels Jun 25, 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 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%'

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.

high

The uriTemplate for material_ui incorrectly points to the cupertino_ui directory. It should be updated to point to material_ui instead.

    uriTemplate: 'https://github.com/flutter/packages/blob/material_ui-v0.0.2/packages/material_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

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.

@chunhtai does the batch release process bump the version? Will it need to handle this as well?

@Piinks Piinks changed the title Add linkToSource [material_ui, cupertino_ui] Add linkToSource Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD 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.

2 participants