Skip to content

Update (package_info_plus): Change Readme for more clarity#518

Merged
miquelbeltran merged 1 commit intofluttercommunity:mainfrom
vbuberen:patch-1
Oct 6, 2021
Merged

Update (package_info_plus): Change Readme for more clarity#518
miquelbeltran merged 1 commit intofluttercommunity:mainfrom
vbuberen:patch-1

Conversation

@vbuberen
Copy link
Copy Markdown
Collaborator

@vbuberen vbuberen commented Oct 5, 2021

Description

This is a minor README update inspired by the same change in #517, but this time for another package. I believe that mentioning WidgetsFlutterBinding.ensureInitialized() below code sample as it was before change in this PR is something that some users might miss, while proposed change ensures people will see the note on what should be done in case fromPlatform() is called before runApp().

Related Issues

It is closed already, but still #309 is related here.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (flutter analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
  • No, this is not a breaking change.

@miquelbeltran
Copy link
Copy Markdown
Member

Thanks, that is necessary in all cases when the code is calling to platform channels before runApp, not only to this particular package, but I am fine to add that to this README.

@miquelbeltran miquelbeltran added Hacktoberfest Issues taking part in Hacktoberfest hacktoberfest-accepted labels Oct 6, 2021
@miquelbeltran miquelbeltran merged commit a87a511 into fluttercommunity:main Oct 6, 2021
@vbuberen vbuberen deleted the patch-1 branch February 20, 2022 14:48
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Feb 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Hacktoberfest Issues taking part in Hacktoberfest hacktoberfest-accepted

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants