Skip to content

[go_router] Fix missing build parameter in type-safe routes topic documentation#5040

Merged
auto-submit[bot] merged 4 commits into
flutter:mainfrom
yamhoresh:patch-1
Oct 12, 2023
Merged

[go_router] Fix missing build parameter in type-safe routes topic documentation#5040
auto-submit[bot] merged 4 commits into
flutter:mainfrom
yamhoresh:patch-1

Conversation

@yamhoresh

@yamhoresh yamhoresh commented Sep 30, 2023

Copy link
Copy Markdown
Contributor

Added the missing GoRouterState state parameter to the build methods of HomeScreenRoute and SongRoute, to the type-safe routes topic.

Using the current documentation (without the fix), raises the error:

'HomeScreenRoute.build' ('Widget Function(BuildContext)') isn't a valid override of
'GoRouteData.build' ('Widget Function(BuildContext, GoRouterState)')

I didn't find any issue for this, but if you'd want I could simply open one myself and link it to this pull request.

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.

Added the missing GoRouterState state parameter to the build methods.

@chunhtai chunhtai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@chunhtai chunhtai requested a review from hannah-hyj October 12, 2023 17:19

@hannah-hyj hannah-hyj left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

@hannah-hyj

Copy link
Copy Markdown
Member

@yamhoresh can you fix the merge conflict?

@yamhoresh

Copy link
Copy Markdown
Contributor Author

@Hangyujin Sure thing, I'm on it.

@chunhtai chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 12, 2023
@auto-submit auto-submit Bot merged commit fd84e65 into flutter:main Oct 12, 2023
@yamhoresh yamhoresh deleted the patch-1 branch October 12, 2023 18:42
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 13, 2023
auto-submit Bot pushed a commit to flutter/flutter that referenced this pull request Oct 13, 2023
flutter/packages@93c3f69...fd84e65

2023-10-12 48316647+yamhoresh@users.noreply.github.com [go_router] Fix missing build parameter in type-safe routes topic documentation (flutter/packages#5040)
2023-10-12 engine-flutter-autoroll@skia.org Roll Flutter (stable) from ead4559 to 2f708eb (1 revision) (flutter/packages#5134)
2023-10-12 goderbauer@google.com [web_benchmarks] Bump process version constraints (flutter/packages#5122)

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
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
…umentation (flutter#5040)

Added the missing GoRouterState state parameter to the build methods of `HomeScreenRoute` and `SongRoute`, to the type-safe routes [topic](https://github.com/flutter/packages/blob/main/packages/go_router/doc/type-safe-routes.md).

Using the current documentation (without the fix), raises the error:
``` dart
'HomeScreenRoute.build' ('Widget Function(BuildContext)') isn't a valid override of
'GoRouteData.build' ('Widget Function(BuildContext, GoRouterState)')
```

I didn't find any issue for this, but if you'd want I could simply open one myself and link it to this pull request.
bisor0627 pushed a commit to bisor0627/packages that referenced this pull request Jun 19, 2026
…umentation (flutter#5040)

Added the missing GoRouterState state parameter to the build methods of `HomeScreenRoute` and `SongRoute`, to the type-safe routes [topic](https://github.com/flutter/packages/blob/main/packages/go_router/doc/type-safe-routes.md).

Using the current documentation (without the fix), raises the error:
``` dart
'HomeScreenRoute.build' ('Widget Function(BuildContext)') isn't a valid override of
'GoRouteData.build' ('Widget Function(BuildContext, GoRouterState)')
```

I didn't find any issue for this, but if you'd want I could simply open one myself and link it to this pull request.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App p: go_router

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants