Update plugin migration instructions #12591
Conversation
Summary of ChangesHello @vashworth, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refines the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
| yet available on stable. You may consider publishing a | ||
| [prerelease version](https://dart.dev/tools/pub/publishing#publishing-prereleases) | ||
| of your plugin to migrate early. | ||
| ::: |
There was a problem hiding this comment.
@stuartmorgan-g What do you think of this?
There was a problem hiding this comment.
Reading the docs again, I think we want to say "prerelease or preview version". Either works for this scenario, and I think preview is actually more likely to be what people would want to do if they do either.
There was a problem hiding this comment.
Are you sure previews work for the Flutter SDK? The docs make it sound specific to the Dart SDK version
There was a problem hiding this comment.
I'm not 100% sure that it trigger the pub.dev preview if you only set the Flutter SDK, but you could just set both: the Flutter SDK to the version you need, and the Dart SDK to the version of Dart that shipped with that version of Flutter.
There was a problem hiding this comment.
Sounds good, updated.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This PR updates the plugin migration instructions by reordering the sections and adding a warning about API availability. The changes are logical and improve the structure of the document. I've left a few comments to improve the clarity and correctness of the documentation:
- A suggestion to fix a line that exceeds the 80-character limit.
- A request for clarification on an ambiguous instruction.
- Corrections for invalid code examples in both Swift and Objective-C to ensure they are compilable.
Addressing these points will improve the quality of the guide for developers.
|
Visit the preview URL for this PR (updated for commit 80b0de0): https://flutter-docs-prod--pr12591-uiscene-plugin-migration-up-5us3luoq.web.app |
In the Google Developer Doc Writing Guide, "may" is reserved for legal text. Use "might" or "can" otherwise.
|
@sfshaza2 This is ready to merge now! |
4 participants
Description of what this PR is changing or adding, and why:
This change moves the plugin migration guide to the bottom so app migrations are first.
This also adds a warning that plugin APIs are not available on stable yet.
Issues fixed by this PR (if any):
PRs or commits this PR depends on (if any):
Presubmit checklist
of 80 characters or fewer.