Skip to content

[Pigeon] readme updates - #3705

Merged
auto-submit[bot] merged 29 commits into
flutter:mainfrom
tarrinneal:pigeon-README
Jun 30, 2023
Merged

[Pigeon] readme updates#3705
auto-submit[bot] merged 29 commits into
flutter:mainfrom
tarrinneal:pigeon-README

Conversation

@tarrinneal

@tarrinnealtarrinneal commented Apr 13, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

Updates README's to better reflect modern pigeon and it's usage.
Very open to feedback on this, please let me know what could be better, clearer, or is just missing from this documentation.
I don't expect to be able to cover all uses with this, if people want to see all possibilities, I think looking into our very thorough integration tests will provide them with anything they could need (all of which is linked in the example README).

fixesflutter/flutter#66511
partial work for flutter/flutter#123851
fixesflutter/flutter#108531
fixesflutter/flutter#92641

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.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@tarrinneal
tarrinneal marked this pull request as ready for review June 23, 2023 21:22
@tarrinneal
tarrinneal marked this pull request as draft June 24, 2023 02:09
@tarrinneal
tarrinneal removed the request for review from stuartmorgan-gJune 24, 2023 02:09
@tarrinneal
tarrinneal marked this pull request as ready for review June 26, 2023 19:00
@tarrinneal

tarrinneal commented Jun 28, 2023

Copy link
Copy Markdown
ContributorAuthor

@bparrishMines Can you read through the 2 README files here and see if you think they could be improved?

stuartmorgan-g
stuartmorgan-g requested changes Jun 30, 2023
View reviewed changes
Comment threadpackages/pigeon/README.md Outdated
Comment threadpackages/pigeon/example/README.md
Comment threadpackages/pigeon/example/README.md Outdated
Comment threadpackages/pigeon/example/README.md Outdated
Comment threadpackages/pigeon/example/README.md
Comment threadpackages/pigeon/example/app/windows/runner/flutter_window.cpp Outdated
Comment threadpackages/pigeon/example/README.md Outdated
Comment threadpackages/pigeon/lib/pigeon_lib.dart Outdated
Comment threadpackages/pigeon/tool/run_tests.dart Outdated
stuartmorgan-g
stuartmorgan-g approved these changes Jun 30, 2023
View reviewed changes

@stuartmorgan-gstuartmorgan-g left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM with one more thing.

Comment threadpackages/pigeon/lib/pigeon_lib.dart Outdated
@tarrinnealtarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 30, 2023
@auto-submit
auto-submitBot merged commit d3c0d5f into flutter:mainJun 30, 2023
@engine-flutter-autorollengine-flutter-autoroll mentioned this pull request Jul 3, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 3, 2023
@engine-flutter-autoroll
d3c0d5f[Pigeon] readme updates (flutter/packages#3705)
2cf619a
@engine-flutter-autorollengine-flutter-autoroll mentioned this pull request Jul 3, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 3, 2023
@engine-flutter-autoroll
d3c0d5f[Pigeon] readme updates (flutter/packages#3705)
11610d7
auto-submitBot pushed a commit to flutter/flutter that referenced this pull request Jul 3, 2023
@engine-flutter-autoroll
Roll Packages from53ed5a0tocdae854(9 revisions) (#129918)
ddb16b7
flutter/packages@53ed5a0...cdae854
2023-07-01 engine-flutter-autoroll@skia.org Roll Flutter from ff838bc to aa5f4a2 (29 revisions) (flutter/packages#4363)
2023-07-01 stuartmorgan@google.com [tool] Add a flag to skip cleanup (flutter/packages#4357)
2023-07-01 stuartmorgan@google.com [file_selector] Endorse Android (flutter/packages#4329)
2023-07-01 stuartmorgan@google.com [google_sign_in] Convert Android to Pigeon (flutter/packages#4344)
2023-06-30 tarrinneal@gmail.com [Pigeon] readme updates (flutter/packages#3705)
2023-06-30 43054281+camsim99@users.noreply.github.com [camera_android] Support concurrently image capture and image streaming (flutter/packages#4332)
2023-06-30 kustermann.martin@gmail.com Prepare for utf8.encode() to return more precise Uint8List type (flutter/packages#4342)
2023-06-30 tarrinneal@gmail.com [shared_preferences] Adds allowList to setPrefix method. (flutter/packages#3794)
2023-06-30 engine-flutter-autoroll@skia.org Roll Flutter from 51bef1b to ff838bc (12 revisions) (flutter/packages#4346)
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 flutter-ecosystem@google.com,rmistry@google.com 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
This was referenced Jul 7, 2023
Merged
Closed
Merged
@reidbakerreidbaker mentioned this pull request Jul 26, 2023
Merged
11 tasks
@reidbakerreidbaker mentioned this pull request Aug 4, 2023
Merged
11 tasks
@gnpricegnprice mentioned this pull request Mar 26, 2024
Open
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
@tarrinneal
[Pigeon] readme updates (flutter#3705)
0cc898f
Updates README's to better reflect modern pigeon and it's usage. Very open to feedback on this, please let me know what could be better, clearer, or is just missing from this documentation.
I don't expect to be able to cover all uses with this, if people want to see all possibilities, I think looking into our very thorough integration tests will provide them with anything they could need (all of which is linked in the example README).
fixesflutter/flutter#66511
partial work for flutter/flutter#123851fixesflutter/flutter#108531fixesflutter/flutter#92641
bisor0627 pushed a commit to bisor0627/packages that referenced this pull request Jun 19, 2026
@tarrinneal
[Pigeon] readme updates (flutter#3705)
9f162da
Updates README's to better reflect modern pigeon and it's usage. Very open to feedback on this, please let me know what could be better, clearer, or is just missing from this documentation.
I don't expect to be able to cover all uses with this, if people want to see all possibilities, I think looking into our very thorough integration tests will provide them with anything they could need (all of which is linked in the example README).
fixesflutter/flutter#66511
partial work for flutter/flutter#123851fixesflutter/flutter#108531fixesflutter/flutter#92641
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stuartmorgan-gstuartmorgan-gstuartmorgan-g approved these changes
@bparrishMinesbparrishMinesAwaiting requested review from bparrishMines

Assignees

No one assigned

Labels

autosubmitMerge PR when tree becomes green via auto submit Appp: pigeonplatform-androidplatform-iosplatform-macosplatform-windows

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[pigeon] Better documentation for @FlutterApi usage [pigeon] Example code on pub.dev doesn't compile [pigeon] improve documentation

2 participants

@tarrinneal@stuartmorgan-g