[quick_actions] Adopt code-excerpts for README - #12643
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
8ec30ab to
bf1351c
Compare
Replaces the hand-written Dart snippets in the README with <?code-excerpt?> pragmas backed by example/lib/readme_excerpts.dart, so they're validated against compilable, analyzed source instead of being free-hand text (one used an untyped callback parameter and print(), which isn't allowed by the repo's lint rules). Also drops the package's ci_config.yaml, whose only purpose was opting it out of that validation. Part of flutter/flutter#102679. FPOCTSMP-10
bf1351c to
729590c
Compare
There was a problem hiding this comment.
Code Review
This pull request integrates code-excerpt into the quick_actions package README to validate Dart snippets against compilable source code. It adds a new readme_excerpts.dart file containing the code snippets, updates the README to reference these excerpts, removes the exempt_from_excerpts flag, and bumps the package version to 1.1.1. There are no review comments to address.
Replaces the hand-written Dart snippets in
quick_actions's README with<?code-excerpt?>pragmas backed byexample/lib/readme_excerpts.dart, so they're validated against compilable, analyzed source instead of free-hand text (the original used an untyped callback parameter andprint(), which the repo's lint rules disallow). Also drops the package'sci_config.yaml, whose only purpose was opting it out of that validation.Follows the same pattern as #12641 ([pointer_interceptor] Adopt code-excerpts for README).
Part of #102679.
Pre-Review Checklist
[shared_preferences]1.1.1).///). — not applicable, no public API surface changed.readme_excerpts.dartis validated bydart analyze/dart formatand theupdate-excerptscheck itself; no runtime behavior changed.Test plan
dart run script/tool/bin/flutter_plugin_tools.dart update-excerpts --packages=quick_actions— no diff after regenerationdart run script/tool/bin/flutter_plugin_tools.dart validate --packages=quick_actions— no issuesflutter analyzeinexample/— no issuesdart format --output=none --set-exit-if-changedon the new excerpts file — no changes neededflutter testin the package — all tests passNote: The Flutter team is currently trialing Gemini Code Assist for GitHub. Comments from
gemini-code-assist[bot]aren't authoritative Flutter-team feedback; I'll wait for a human reviewer's guidance on which automated comments (if any) 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. ↩