Skip to content

[plugin_platform_interface] Adopt code-excerpts #4534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 20, 2023
Merged

[plugin_platform_interface] Adopt code-excerpts #4534

merged 3 commits into from
Jul 20, 2023

Conversation

stuartmorgan-g
Copy link
Contributor

Updates the README to use code excerpts from the unit test file, adjusting the existing test code slightly to make it suitable for use in the example.

Also fleshes out the example a bit more, to make it look more like a real class.

Finally, adds a note about base, linking to the ongoing discussion, since we don't have a decision yet, but people may well wonder why this class exists given base.

Part of flutter/flutter#102679

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

@stuartmorgan-g
[plugin_platform_interface] Adopt code-excerpts
9aa9d1a 
Updates the README to use code excerpts from the unit test file,
adjusting the existing test code slightly to make it suitable for use in
the example.

Also fleshes out the example a bit more, to make it look more like a
real class.

Finally, adds a note about `base`, linking to the ongoing discussion,
since we don't have a decision yet, but people may well wonder why this
class exists given `base`.

Part of flutter/flutter#102679
tarrinneal
tarrinneal approved these changes Jul 20, 2023
View reviewed changes
Copy link
Contributor

@tarrinneal tarrinneal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one nit

packages/plugin_platform_interface/README.md Outdated

In Dart 3, [the `base` keyword](https://dart.dev/language/class-modifiers#base)
was introduced to the language, which allows enforcing that implementations
of an interface use `extends` rather than `implements`. The Flutter team is
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"which allows enforcing that implementations of an interface use"

I'm not sure what this is supposed to say

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I adjusted the wording; hopefully it's clearer now.

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 20, 2023
@auto-submit auto-submit bot merged commit 05fdd13 into flutter:main Jul 20, 2023
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jul 21, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 21, 2023
@engine-flutter-autoroll
05fdd13 [plugin_platform_interface] Adopt code-excerpts (flutter/pack…
34b2ab7 
…ages#4534)
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Jul 21, 2023
@engine-flutter-autoroll
Roll Packages from 674179f to 2266a76 (6 revisions) (#131058)
9cfbf6b 
flutter/packages@674179f...2266a76

2023-07-21 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 2.20.4 to 2.21.0 (flutter/packages#4525)
2023-07-20 [email protected] [url_launcher_android] Set `buildFeatures.buildConfig` to true for compatibility with AGP 8.0+ (flutter/packages#4535)
2023-07-20 [email protected] [go_router] fix error handling page link (flutter/packages#4296)
2023-07-20 [email protected] [plugin_platform_interface] Adopt code-excerpts (flutter/packages#4534)
2023-07-20 [email protected] [ci] Simplify Dockerfile (flutter/packages#4530)
2023-07-20 [email protected] [ci] Enable Windows Dart unit test sharding (flutter/packages#4528)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
@reidbaker reidbaker mentioned this pull request Jul 26, 2023
Merged
11 tasks
LouiseHsu pushed a commit to LouiseHsu/flutter that referenced this pull request Jul 31, 2023
@engine-flutter-autoroll @LouiseHsu
Roll Packages from 674179f to 2266a76 (6 revisions) (flutter#131058)
f00e80f 
flutter/packages@674179f...2266a76

2023-07-21 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 2.20.4 to 2.21.0 (flutter/packages#4525)
2023-07-20 [email protected] [url_launcher_android] Set `buildFeatures.buildConfig` to true for compatibility with AGP 8.0+ (flutter/packages#4535)
2023-07-20 [email protected] [go_router] fix error handling page link (flutter/packages#4296)
2023-07-20 [email protected] [plugin_platform_interface] Adopt code-excerpts (flutter/packages#4534)
2023-07-20 [email protected] [ci] Simplify Dockerfile (flutter/packages#4530)
2023-07-20 [email protected] [ci] Enable Windows Dart unit test sharding (flutter/packages#4528)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
@reidbaker reidbaker mentioned this pull request Aug 4, 2023
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tarrinneal tarrinneal tarrinneal approved these changes

@bparrishMines bparrishMines Awaiting requested review from bparrishMines

Assignees
No one assigned
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: plugin_platform_interface
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@stuartmorgan-g @tarrinneal