packages icon indicating copy to clipboard operation
packages copied to clipboard

Published 20 hours ago • verified publisher icon flutter

[pigeon] Update README to clarify host handler setup (fixes #140025)

Open jaysephjw opened this issue 1 year ago • 4 comments

Call out the host implementation setup step more clearly in the USAGE docs. Provide examples.

https://github.com/flutter/flutter/issues/140327

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.

jaysephjw avatar Dec 18 '23 16:12 jaysephjw

Good call out on the lack of example for the messenger set up.

Adding examples to our READMEs is a little more complicated than just adding inline text, I'd recommend looking at the linked example code (which is another readme) and adding the missing lines of code to the examples there.

This involves actually going to the referenced files and adding the code to those, then running the code excerpting tool.

see: Tooling info

tarrinneal avatar Dec 18 '23 20:12 tarrinneal

Thanks for the submission!

In the future, please do not delete the checklist that is in the PR template; it is there for a reason. This PR is missing required elements described in the checklist (I’ve restored it to the PR description), which need to be addressed before it moves forward with review.

I am marking the PR as a Draft. Please review the checklist, updating the PR as appropriate, and when that’s complete please feel free to mark the PR as ready for review.

stuartmorgan-g avatar Jan 03 '24 16:01 stuartmorgan-g

(triage) @jaysephjw Do you still have plans to come back to this PR and address the feedback given above?

goderbauer avatar Mar 05 '24 23:03 goderbauer

@goderbauer thanks for the bump- I’d like to, let me try to find some time for it.

jaysephjw avatar Mar 06 '24 00:03 jaysephjw

Since this is marked as a draft and hasn't been updated in several months I'm going to close it to clean out our review queue. Please don't hesitate to submit a new PR if you decide to revisit this. Thanks!

stuartmorgan-g avatar Jun 04 '24 19:06 stuartmorgan-g