[pointer_interceptor] Adopt code-excerpts for README - #12641
[pointer_interceptor] Adopt code-excerpts for README#12641danielleon-cmd wants to merge 14 commits into
Conversation
There was a problem hiding this comment.
Code Review
This pull request adopts code-excerpt for the pointer_interceptor README's Dart snippets, moving the code examples into a new compilable file readme_excerpts.dart and updating the package version to 0.10.1+3. Additionally, it adds Swift unit tests to quick_actions_ios for setting shortcut items with multiple items or without an icon, and to url_launcher_ios for handling Safari view controller launch failures with invalid URLs. There are no review comments, and no feedback is provided.
915b93e to
1060435
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 of them had a stray trailing comma that made it invalid Dart). Also drops the package's ci_config.yaml, whose only purpose was opting it out of that validation. Part of flutter/flutter#102679. FPOCTSMP-9
…hange Converts the NEXT section into a real release since the README change needs to be published, and bumps pubspec.yaml to match.
9d49a6e to
44956cf
Compare
There was a problem hiding this comment.
Code Review
This pull request adopts code-excerpt for the pointer_interceptor package's README Dart snippets. It adds a new file readme_excerpts.dart containing compilable Dart snippets, updates the README to reference these excerpts, removes the exempt_from_excerpts configuration, and bumps the package version to 0.10.1+3. There are no review comments, and I have no feedback to provide.
|
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. |
|
No NEED for tests since it is just a plain documentation |
Replaces the hand-written Dart snippets in
pointer_interceptor's README with<?code-excerpt?>pragmas backed by a newexample/lib/readme_excerpts.dart, so the README's examples are validated against compilable, analyzed source (update-excerpts --fail-on-change) instead of free-hand text. One of the previous snippets was actually invalid Dart (a stray trailing comma), which this now catches. Also removes the package'sci_config.yaml, whose only content wasexempt_from_excerpts: true, now that the excerpt validation actually runs and passes.Part of flutter/flutter#102679.
Pre-Review Checklist
[shared_preferences]0.10.1+3).///). — not applicable, no public API surface changed.readme_excerpts.dartis validated bydart analyze/dart formatand theupdate-excerpts --fail-on-changecheck itself, which is the point of this change; no runtime behavior changed.Test plan
dart run script/tool/bin/flutter_plugin_tools.dart update-excerpts --fail-on-change --packages pointer_interceptordart run script/tool/bin/flutter_plugin_tools.dart validate --packages pointer_interceptor/pointer_interceptor(excerpt validation now runs, not skipped)dart run script/tool/bin/flutter_plugin_tools.dart analyze --packages pointer_interceptor/pointer_interceptordart format --output=none --set-exit-if-changedon the new source fileNote: 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. ↩