Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Remove pubspec.yaml examples from READMEs #4198

Merged

Conversation

stuartmorgan
Copy link
Contributor

@stuartmorgan stuartmorgan commented Jul 27, 2021

Demonstrations of how to add a plugin dependency in pubspec.yaml
inevitably become outdated, causing more confusion than they solve.
pub.dev has an installation tab which shows the same example but using a
dynamic version, so these instructions are almost never necessary; where
specifically referencing installation is useful, link to that tab
instead of an inline, hard-coded example.

Many of these examples were in implementation packages that were not
endorsed, and had never been updated to indicate that they are now
endorsed, so this PR also corrects those READMEs to indicate that they
are in fact endorsed.

Fixes flutter/flutter#87056

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. (Note that unlike the flutter/flutter repo, the flutter/plugins repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the plugin 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.
  • I updated CHANGELOG.md to add a description of the change.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test exempt.
  • All existing and new tests are passing.

Demonstrations of how to add a plugin dependency in pubspec.yaml
inevitably become outdated, causing more confusion than the solve.
pub.dev has an installation tab which shows the same example but using a
dynamic version, so these instructions are almost never necessary; where
specifically referencing installation is useful, link to that tab
instead of an inline, hard-coded example.

Many of these examples were in implementation packages that were not
endorsed, and had never been updated to indicate that they are now
endorsed, so this PR also corrects those READMEs to indicate that they
are in fact endorsed.

Fixes flutter/flutter#87056
@@ -1,195 +1,3 @@
# e2e (deprecated)

## DEPRECATED

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This package is several deprecations old, and only this README exists in the tree (in case people have links to the package), so rather than do a targeted update I just nuked everything but the pointer.

Copy link
Member

Choose a reason for hiding this comment

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

Yep, looks good to me!

Copy link
Member

@ditman ditman left a comment

Choose a reason for hiding this comment

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

LGTM, I like the new verbiage much better. Thanks for doing this!

@@ -1,195 +1,3 @@
# e2e (deprecated)

## DEPRECATED

Copy link
Member

Choose a reason for hiding this comment

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

Yep, looks good to me!

@stuartmorgan stuartmorgan added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Jul 27, 2021
@fluttergithubbot fluttergithubbot merged commit d2f5c33 into flutter:master Jul 27, 2021
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 27, 2021
fotiDim pushed a commit to fotiDim/plugins that referenced this pull request Sep 13, 2021
amantoux pushed a commit to amantoux/plugins that referenced this pull request Sep 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
3 participants