-
Notifications
You must be signed in to change notification settings - Fork 3.4k
[go_router_builder] Fixes readme typos and uses code excerpts. #7280
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact "@test-exemption-reviewer" in the #hackers channel in Chat (don't just cc them here, they won't see it! Use Discord!). If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix? Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. |
test-exempt: adopting code excerpts is effectively an increase in test coverage since it moves code samples from raw text to code that is run through the analyzer. |
Does this adopt it for everything? If so, the package should be removed from https://github.com/flutter/packages/blob/main/script/configs/temp_exclude_excerpt.yaml in this PR. |
removed from the list |
GoRoute( | ||
path: ':familyId', | ||
builder: (BuildContext context, GoRouterState state) { | ||
// require the familyId to be present and be an integer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments, especially for docs, should be capitalized and punctuated like a sentence.
|
||
// #docregion RedirectRoute | ||
class RedirectRoute extends GoRouteData { | ||
// no need to implement [build] when this [redirect] is unconditional |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here.
class MyMaterialRouteWithKey extends GoRouteData { | ||
static const LocalKey _key = ValueKey<String>('my-route-with-key'); | ||
@override | ||
MaterialPage<void> buildPage(BuildContext context, GoRouterState state) => |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This, and at least one more below, violate https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#consider-using--for-short-functions-and-methods
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
auto label is removed for flutter/packages/7280, due to - The status or check suite Mac_arm64 ios_platform_tests_shard_2 master has failed. Please fix the issues identified (or deflake) before re-applying this label. |
auto label is removed for flutter/packages/7280, due to - The status or check suite Mac_arm64 ios_platform_tests_shard_2 master has failed. Please fix the issues identified (or deflake) before re-applying this label. |
There's an infra issue with macOS hosts in the presubmit pool that we haven't been able to figure out, and it's hitting flutter/packages very hard. Expect to need to re-run some macOS host test shards several times in order to land, unfortunately. |
auto label is removed for flutter/packages/7280, 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.
|
flutter/packages@82e8d1e...551bde5 2024-08-06 engine-flutter-autoroll@skia.org Manual roll Flutter from 3832823 to 1dd7141 (21 revisions) (flutter/packages#7317) 2024-08-06 rexios@rexios.dev [google_maps_flutter_web] Web changes to support heatmaps (flutter/packages#7315) 2024-08-06 rexios@rexios.dev [google_maps_flutter_ios] iOS changes to support heatmaps (flutter/packages#7314) 2024-08-06 rexios@rexios.dev [google_maps_flutter_android] Android changes to support heatmaps (flutter/packages#7313) 2024-08-06 rexios@rexios.dev [camera_web] Migrate to `package:web` (flutter/packages#7012) 2024-08-06 47866232+chunhtai@users.noreply.github.com [go_router_builder] Fixes readme typos and uses code excerpts. (flutter/packages#7280) 2024-08-05 pateltirth454@gmail.com [go_router] redirect example signature fix (flutter/packages#7278) 2024-08-05 rexios@rexios.dev [google_maps_flutter_platform_interface] Platform interface changes to support heatmaps (flutter/packages#7312) 2024-08-05 41930132+hellohuanlin@users.noreply.github.com [pointer_interceptor] Add performance warning on using pointer interceptor on iOS (flutter/packages#7288) 2024-08-05 engine-flutter-autoroll@skia.org Roll Flutter from cbfb222 to 3832823 (4 revisions) (flutter/packages#7316) 2024-08-05 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 4.3.4 to 4.3.5 (flutter/packages#7308) 2024-08-05 49699333+dependabot[bot]@users.noreply.github.com [image_picker]: Bump androidx.annotation:annotation from 1.8.0 to 1.8.1 in /packages/image_picker/image_picker_android/android (flutter/packages#7302) 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://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
flutter/packages@82e8d1e...551bde5 2024-08-06 engine-flutter-autoroll@skia.org Manual roll Flutter from 3832823 to 1dd7141 (21 revisions) (flutter/packages#7317) 2024-08-06 rexios@rexios.dev [google_maps_flutter_web] Web changes to support heatmaps (flutter/packages#7315) 2024-08-06 rexios@rexios.dev [google_maps_flutter_ios] iOS changes to support heatmaps (flutter/packages#7314) 2024-08-06 rexios@rexios.dev [google_maps_flutter_android] Android changes to support heatmaps (flutter/packages#7313) 2024-08-06 rexios@rexios.dev [camera_web] Migrate to `package:web` (flutter/packages#7012) 2024-08-06 47866232+chunhtai@users.noreply.github.com [go_router_builder] Fixes readme typos and uses code excerpts. (flutter/packages#7280) 2024-08-05 pateltirth454@gmail.com [go_router] redirect example signature fix (flutter/packages#7278) 2024-08-05 rexios@rexios.dev [google_maps_flutter_platform_interface] Platform interface changes to support heatmaps (flutter/packages#7312) 2024-08-05 41930132+hellohuanlin@users.noreply.github.com [pointer_interceptor] Add performance warning on using pointer interceptor on iOS (flutter/packages#7288) 2024-08-05 engine-flutter-autoroll@skia.org Roll Flutter from cbfb222 to 3832823 (4 revisions) (flutter/packages#7316) 2024-08-05 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 4.3.4 to 4.3.5 (flutter/packages#7308) 2024-08-05 49699333+dependabot[bot]@users.noreply.github.com [image_picker]: Bump androidx.annotation:annotation from 1.8.0 to 1.8.1 in /packages/image_picker/image_picker_android/android (flutter/packages#7302) 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://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
flutter/packages@82e8d1e...551bde5 2024-08-06 engine-flutter-autoroll@skia.org Manual roll Flutter from 3832823 to 1dd7141 (21 revisions) (flutter/packages#7317) 2024-08-06 rexios@rexios.dev [google_maps_flutter_web] Web changes to support heatmaps (flutter/packages#7315) 2024-08-06 rexios@rexios.dev [google_maps_flutter_ios] iOS changes to support heatmaps (flutter/packages#7314) 2024-08-06 rexios@rexios.dev [google_maps_flutter_android] Android changes to support heatmaps (flutter/packages#7313) 2024-08-06 rexios@rexios.dev [camera_web] Migrate to `package:web` (flutter/packages#7012) 2024-08-06 47866232+chunhtai@users.noreply.github.com [go_router_builder] Fixes readme typos and uses code excerpts. (flutter/packages#7280) 2024-08-05 pateltirth454@gmail.com [go_router] redirect example signature fix (flutter/packages#7278) 2024-08-05 rexios@rexios.dev [google_maps_flutter_platform_interface] Platform interface changes to support heatmaps (flutter/packages#7312) 2024-08-05 41930132+hellohuanlin@users.noreply.github.com [pointer_interceptor] Add performance warning on using pointer interceptor on iOS (flutter/packages#7288) 2024-08-05 engine-flutter-autoroll@skia.org Roll Flutter from cbfb222 to 3832823 (4 revisions) (flutter/packages#7316) 2024-08-05 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 4.3.4 to 4.3.5 (flutter/packages#7308) 2024-08-05 49699333+dependabot[bot]@users.noreply.github.com [image_picker]: Bump androidx.annotation:annotation from 1.8.0 to 1.8.1 in /packages/image_picker/image_picker_android/android (flutter/packages#7302) 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://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
as title
should clear go_router_builder from the list, since only readme has code example flutter/flutter#102679
Pre-launch Checklist
dart format
.)[shared_preferences]
pubspec.yaml
with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.md
to add a description of the change, following repository CHANGELOG style, or this PR is exempt from CHANGELOG changes.///
).If you need help, consider asking for advice on the #hackers-new channel on Discord.