[rfw] Add some more documentation for RFW #4349

Hixie · 2023-06-30T00:13:07Z

Pre-launch Checklist

Hixie · 2023-06-30T00:13:31Z

test-exempt: documentation-only change

stuartmorgan · 2023-06-30T00:20:48Z

Given that you are adding a bunch more code here, this would be a good time to undo rfw's temporary grandfathered-in exception to the code-excerpt policy, rather than adding more freehand code to the README.

Hixie · 2023-06-30T20:56:55Z

How do I do that while keeping the code in the README slightly different to the code in the examples? I have bespoke comments that are intentionally not the same in both because the reason you read one is not the reason you read the other (e.g. the example/hello case has comments in the README that flow from the text in the README, which don't make sense out of context).

Hixie · 2023-06-30T21:03:52Z

(Any idea how to use it with rfwtxt files? Or to extract text from strings inside Dart files?)

Hixie · 2023-06-30T21:10:59Z

Is there a way to take code from different examples, and from tests? The documentation in the wiki seems to assume there's only one example that you're pulling sample code from.

stuartmorgan · 2023-06-30T21:36:45Z

How do I do that while keeping the code in the README slightly different to the code in the examples?

In other packages where we want code that doesn't make sense in the core example code we made a new file (usually "readme_excerpts.dart" IIRC) put the code there, with a comment at the top saying that it's not part of the example app, and is there for the README.

Any idea how to use it with rfwtxt files?

I don't know what they look like, but I think the code-excerpt tool from the website repo that this is using is pretty file-agnostic. If you can put start/end directives in the file it may well just work. (But if not, this is currently only enforced for blocks annotated as dart.)

Is there a way to take code from different examples, and from tests? The documentation in the wiki seems to assume there's only one example that you're pulling sample code from.

That's just because almost none of our package have multiple examples. It should Just Work if you replace "example/" with "example/whatever/" when it takes about file paths. The repo tool will extract from all examples that are configured for it, and the extraction output is already example-package-name scoped.

There's information in the wiki about pulling from tests, but I've not done it personally. IIRC David added that after doing it for some package, but it's not been widely done.

gnprice

Very interesting! I'd run across mention of this package, but hadn't previously read any example code closely or tried to use it, so this is largely a fresh read from that perspective. The new text looks quite helpful; some comments below.

packages/rfw/README.md

Hixie · 2023-07-06T23:49:21Z

@gnprice thanks for the detailed review!

packages/rfw/README.md

gnprice · 2023-07-07T04:31:29Z

Cool, those changes were helpful. Just read through all the revised or commented-on parts again, and have a smaller number of comments this time around.

Those are above in a couple of batches, because that's how GitHub behaves when one replies on a comment thread from the main PR page after queueing up some other comments on the "files" page.

Hixie · 2023-07-11T06:54:38Z

Blocked on #4417

auto-submit · 2023-07-11T23:12:07Z

auto label is removed for flutter/packages, pr: 4349, due to - The status or check suite repo_checks has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2023-07-11T23:44:03Z

auto label is removed for flutter/packages, pr: 4349, due to - The status or check suite Linux_android custom_package_tests stable has failed. Please fix the issues identified (or deflake) before re-applying this label.

The status or check suite android-platform_tests CHANNEL:master PACKAGE_SHARDING:--shardIndex 1 --shardCount 6 has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2023-07-12T00:12:20Z

auto label is removed for flutter/packages, pr: 4349, due to - The status or check suite Mac_arm64 ios_platform_tests_shard_5 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

gnprice

LGTM! Those changes clarify all the remaining points I had; just a couple of nits below.

gnprice · 2023-07-12T01:47:57Z

packages/rfw/README.md

+local widget (which is defined in terms of the `GestureDetector`
+widget from the Flutter framework), and the `args.onPressed` is passed
+to the `onTap` argument of that `GestureDetector` widget.


Suggested change

local widget (which is defined in terms of the `GestureDetector`

widget from the Flutter framework), and the `args.onPressed` is passed

to the `onTap` argument of that `GestureDetector` widget.

local widget (which is defined in terms of the `GestureDetector`

widget from the Flutter framework), and the `args.onPressed` is passed

to the `onTap` argument of that `GestureDetector` local widget.

(Because "GestureDetector widget" appears just a few words earlier with the meaning of the one from the framework, I think this extra bit of explicitness is helpful.)

Further clarified.

Thanks for your attention to detail on this PR btw. I think it's made the text much, much better.

Glad to help!

packages/rfw/README.md

packages/rfw/test/readme_test.dart

)

flutter/packages@188a846...2508714 2023-07-12 [email protected] ADD appBarBreakpoint (flutter/packages#4434) 2023-07-12 [email protected] Roll Flutter from 65ff3cb to 3ec96a8 (5 revisions) (flutter/packages#4415) 2023-07-12 [email protected] [image_picker] Roll dependancies to avoid error (flutter/packages#4431) 2023-07-12 49699333+dependabot[bot]@users.noreply.github.com [in_app_pur]: Bump com.android.billingclient:billing from 6.0.0 to 6.0.1 in /packages/in_app_purchase/in_app_purchase_android/android (flutter/packages#4422) 2023-07-12 [email protected] [file_selector] Avoids using path_provider in web example app. (flutter/packages#4445) 2023-07-12 [email protected] [rfw] Add some more documentation for RFW (flutter/packages#4349) 2023-07-12 [email protected] [ci] Enable LUCI legacy analysis (flutter/packages#4435) 2023-07-11 [email protected] [webview_flutter_wkwebview] NSError.toString (flutter/packages#4441) 2023-07-11 [email protected] [ci] Remove unused Chromium setup (flutter/packages#4437) 2023-07-11 [email protected] [flutter_plugin_tools] Reimplements the excerpt system inline in the tool, rather than relying on a separate package. (flutter/packages#4417) 2023-07-11 [email protected] [ci] Remove webview_flutter implementation opt outs for custom analysis (flutter/packages#4438) 2023-07-11 [email protected] [palette_generator] Add web support to unit tests (flutter/packages#4440) 2023-07-11 [email protected] [tool] Conditionalize color on `stdout` (flutter/packages#4436) 2023-07-11 [email protected] [go_router_builder] Cleans up builder code. (flutter/packages#4356) 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

github-actions bot added the p: rfw Remote Flutter Widgets label Jun 30, 2023

Hixie force-pushed the rfw branch from 45210b6 to 2ebf133 Compare June 30, 2023 20:50

gnprice reviewed Jun 30, 2023

View reviewed changes

Hixie force-pushed the rfw branch 2 times, most recently from 4738f4f to 24f35bc Compare July 7, 2023 00:43

gnprice reviewed Jul 7, 2023

View reviewed changes

packages/rfw/README.md Outdated Show resolved Hide resolved

packages/rfw/README.md Outdated Show resolved Hide resolved

packages/rfw/README.md Outdated Show resolved Hide resolved

Hixie force-pushed the rfw branch 2 times, most recently from d371574 to 8d57ba3 Compare July 10, 2023 23:44

Hixie requested review from tarrinneal and domesticmouse as code owners July 10, 2023 23:44

github-actions bot added p: flutter_markdown p: video_player labels Jul 10, 2023

Hixie force-pushed the rfw branch from 8d57ba3 to 0afee05 Compare July 10, 2023 23:51

Hixie requested review from gmackall, reidbaker, ditman, bparrishMines, stuartmorgan, jonahwilliams and gspencergoog as code owners July 10, 2023 23:51

github-actions bot added the p: camera label Jul 10, 2023

github-actions bot removed p: shared_preferences platform-android labels Jul 11, 2023

Hixie force-pushed the rfw branch from 3cdf7cf to af3ffb0 Compare July 11, 2023 23:10

Hixie added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 11, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jul 11, 2023

Hixie force-pushed the rfw branch from af3ffb0 to dd82675 Compare July 11, 2023 23:22

Hixie added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 11, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jul 11, 2023

Hixie added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 12, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jul 12, 2023

Hixie added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 12, 2023

gnprice approved these changes Jul 12, 2023

View reviewed changes

Hixie removed the autosubmit Merge PR when tree becomes green via auto submit App label Jul 12, 2023

Add some more documentation for RFW

230929b

Hixie force-pushed the rfw branch from 9e42394 to 230929b Compare July 12, 2023 05:22

Hixie added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 12, 2023

auto-submit bot merged commit aaebc6e into flutter:main Jul 12, 2023

engine-flutter-autoroll mentioned this pull request Jul 12, 2023

Roll Packages from 188a8468f557 to a5cfa609362a (13 revisions) flutter/flutter#130416

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 12, 2023

aaebc6e [rfw] Add some more documentation for RFW (flutter/packages#4349

9e46e18

)

engine-flutter-autoroll mentioned this pull request Jul 12, 2023

Roll Packages from 188a8468f557 to 250871431bed (14 revisions) flutter/flutter#130418

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 12, 2023

aaebc6e [rfw] Add some more documentation for RFW (flutter/packages#4349

f95bde5

)

reidbaker mentioned this pull request Jul 14, 2023

[tooling] mark infra steps as infra steps in yaml files #4473

Merged

11 tasks

reidbaker mentioned this pull request Jul 26, 2023

[Tooling] Add google owned cache for dependencies as an option in ci #4567

Merged

11 tasks

reidbaker mentioned this pull request Aug 4, 2023

[All] Expand artifact hub to all plugins #4645

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[rfw] Add some more documentation for RFW #4349

[rfw] Add some more documentation for RFW #4349

Hixie commented Jun 30, 2023 •

edited

Loading

Hixie commented Jun 30, 2023

stuartmorgan commented Jun 30, 2023

Hixie commented Jun 30, 2023

Hixie commented Jun 30, 2023

Hixie commented Jun 30, 2023

stuartmorgan commented Jun 30, 2023

gnprice left a comment

Hixie commented Jul 6, 2023

gnprice commented Jul 7, 2023

Hixie commented Jul 11, 2023

auto-submit bot commented Jul 11, 2023

auto-submit bot commented Jul 11, 2023

auto-submit bot commented Jul 12, 2023

gnprice left a comment

gnprice Jul 12, 2023

Hixie Jul 12, 2023

Hixie Jul 12, 2023

gnprice Jul 12, 2023

[rfw] Add some more documentation for RFW #4349

[rfw] Add some more documentation for RFW #4349

Conversation

Hixie commented Jun 30, 2023 • edited Loading

Pre-launch Checklist

Hixie commented Jun 30, 2023

stuartmorgan commented Jun 30, 2023

Hixie commented Jun 30, 2023

Hixie commented Jun 30, 2023

Hixie commented Jun 30, 2023

stuartmorgan commented Jun 30, 2023

gnprice left a comment

Choose a reason for hiding this comment

Hixie commented Jul 6, 2023

gnprice commented Jul 7, 2023

Hixie commented Jul 11, 2023

auto-submit bot commented Jul 11, 2023

auto-submit bot commented Jul 11, 2023

auto-submit bot commented Jul 12, 2023

gnprice left a comment

Choose a reason for hiding this comment

gnprice Jul 12, 2023

Choose a reason for hiding this comment

Hixie Jul 12, 2023

Choose a reason for hiding this comment

Hixie Jul 12, 2023

Choose a reason for hiding this comment

gnprice Jul 12, 2023

Choose a reason for hiding this comment

Hixie commented Jun 30, 2023 •

edited

Loading