[go_router] Add documentation to some methods in matching.dart by ValentinVignal · Pull Request #3462 · flutter/packages

ValentinVignal · 2023-03-15T07:56:11Z

I was investigating how to fixflutter/flutter#113032 (I will soon public a design proposition as I think the entire RouteMatchList structure needs to be changed from a list to a tree). It is a bit hard to understand what each method was supposed to do so I added some documentation to help future contributors.

Pre-launch Checklist

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

ValentinVignal · 2023-03-15T09:46:47Z

I would think this is a version exempt ?

chunhtai · 2023-03-15T15:09:16Z


- /// the full path pattern that matches the uri.
- /// /family/:fid/person/:pid
+ /// the full path pattern that matches the uri. For example:


Suggested change
/// the full path pattern that matches the uri. For example:
/// The full path pattern that matches the uri.
///
/// For example:

chunhtai · 2023-03-15T15:09:59Z

+/// Returns the list of `RouteMatch` corresponding to the given [loc]. For
+/// example, for a given [loc] `/a/b/c/d`, this function will return the list of
+/// [RouteBase] `[GoRouteA(), GoRouterB(), GoRouteC(), GoRouterD()]`.


Suggested change
/// Returns the list of `RouteMatch` corresponding to the given [loc]. For
/// example, for a given [loc]`/a/b/c/d`, this function will return the list of
/// [RouteBase]`[GoRouteA(), GoRouterB(), GoRouteC(), GoRouterD()]`.
/// Returns the list of `RouteMatch` corresponding to the given [loc].
///
/// For example, for a given [loc]`/a/b/c/d`, this function will return the list of
/// [RouteBase]`[GoRouteA(), GoRouterB(), GoRouteC(), GoRouterD()]`.

chunhtai · 2023-03-15T15:11:58Z

+ /// Generate the full path (ex: `'/family/:fid/person/:pid'`) of a list of
+ /// [RouteMatch].
+ ///
+ /// This methods considers that [matches] is ordered accorresponding to how


I can't quite parse this sentence

I hope docs: Better documentation makes it clearer

chunhtai · 2023-03-15T15:13:11Z

+///
+/// - [loc] is the complete URL to match (without the query parameters). For
+/// example, for the URL `/a/b?c=0`, [loc] will be `/a/b`.
+/// - [restBloc] is the remaining part of the URL to match while [parentBloc] is


restLoc and parenetLoc?

…entation

ValentinVignal · 2023-03-16T01:30:43Z

I would think this is a version exempt ?

Should the label "override: no versioning needed" be added to this PR ? Or should I create a new version?

chunhtai

LGTM, just some more nits

chunhtai · 2023-03-16T16:06:47Z

 static RouteMatchList empty =
 RouteMatchList(<RouteMatch>[], Uri.parse(''), const <String, String>{});

+ /// Generate the full path (ex: `'/family/:fid/person/:pid'`) of a list of


Suggested change
/// Generate the full path (ex: `'/family/:fid/person/:pid'`) of a list of
/// Generates the full path (ex: `'/family/:fid/person/:pid'`) of a list of

chunhtai · 2023-03-16T16:08:38Z

+ /// Generate the full path (ex: `'/family/:fid/person/:pid'`) of a list of
+ /// [RouteMatch].
+ ///
+ /// This methods considers that [matches]'s elements verify the go route


Maybe:
The [matches] must be the in same order of how GoRoutes are matched. For example, if the routes structure is ...

chunhtai · 2023-03-16T16:10:33Z

 }
 }

+/// Returns the list of `RouteMatch` corresponding to the given [loc].


The input parameters should be in quote instead of square bracket.
Suggested change
/// Returns the list of `RouteMatch` corresponding to the given [loc].
/// Returns the list of `RouteMatch` corresponding to the given `loc`.

chunhtai · 2023-03-16T16:10:50Z


+/// Returns the list of `RouteMatch` corresponding to the given [loc].
+///
+/// For example, for a given [loc] `/a/b/c/d`, this function will return the


same here and below

chunhtai · 2023-03-16T16:11:48Z

cc @johnpryan for secondary review

…entation

flutter/packages#3462)

…er#3462) [go_router] Add documentation to some methods in matching.dart

ValentinVignal added 2 commits March 15, 2023 15:49

docs: Add documentation
204bd9e

docs: Update changelogs
5e4338a

ValentinVignal requested a review from chunhtai as a code owner March 15, 2023 07:56

github-actionsBot added the p: go_router label Mar 15, 2023

chunhtai reviewed Mar 15, 2023
View reviewed changes

ValentinVignal added 2 commits March 16, 2023 09:25

docs: Better documentation
f12243a

Merge remote-tracking branch 'upstream/main' into go-router/Add-docum…
d3d689e
…entation

ValentinVignal requested a review from chunhtai March 16, 2023 01:26

chunhtai added the override: no versioning needed Override the check requiring version bumps for most changes label Mar 16, 2023

chunhtai approved these changes Mar 16, 2023
View reviewed changes

chunhtai requested a review from johnpryan March 16, 2023 16:11

johnpryan approved these changes Mar 16, 2023
View reviewed changes

ValentinVignal added 2 commits March 17, 2023 09:12

Merge remote-tracking branch 'upstream/main' into go-router/Add-docum…
b8f25b7
…entation

docs: Better documentation and fix typos
1034adf

ValentinVignal mentioned this pull request Mar 20, 2023
[go_router] When replace is called, reuse the same key when possible #2846
Merged
11 tasks

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 20, 2023

auto-submitBot merged commit cfc5d62 into flutter:mainMar 20, 2023

engine-flutter-autoroll mentioned this pull request Mar 21, 2023
Roll Packages from bbf86a7e1a83 to 694f82b34316 (12 revisions) flutter/flutter#123117
Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 21, 2023
cfc5d62[go_router] Add documentation to some methods in matching.dart (
2badc06
flutter/packages#3462)

nploi pushed a commit to nploi/packages that referenced this pull request Jul 16, 2023
[go_router] Add documentation to some methods in matching.dart (flutt…
218ae06
…er#3462) [go_router] Add documentation to some methods in matching.dart

creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
[go_router] Add documentation to some methods in matching.dart (flutt…
8d8b6fd
…er#3462) [go_router] Add documentation to some methods in matching.dart

bisor0627 pushed a commit to bisor0627/packages that referenced this pull request Jun 19, 2026
[go_router] Add documentation to some methods in matching.dart (flutt…
8ed979f
…er#3462) [go_router] Add documentation to some methods in matching.dart

Navigation Menu

Uh oh!

[go_router] Add documentation to some methods in matching.dart - #3462

[go_router] Add documentation to some methods in matching.dart#3462
auto-submit[bot] merged 6 commits into
flutter:mainfrom
ValentinVignal:go-router/Add-documentation

ValentinVignal commented Mar 15, 2023

Uh oh!

ValentinVignal commented Mar 15, 2023

Uh oh!

chunhtaiMar 15, 2023

Uh oh!

chunhtaiMar 15, 2023

Uh oh!

chunhtaiMar 15, 2023

Uh oh!

ValentinVignalMar 16, 2023

Uh oh!

chunhtaiMar 15, 2023

Uh oh!

ValentinVignal commented Mar 16, 2023

Uh oh!

chunhtai left a comment

Uh oh!

chunhtaiMar 16, 2023

Uh oh!

chunhtaiMar 16, 2023

Uh oh!

chunhtaiMar 16, 2023

Uh oh!

chunhtaiMar 16, 2023•
edited
Loading

Uh oh!

chunhtai commented Mar 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-/// the full path pattern that matches the uri. For example:
+/// The full path pattern that matches the uri.
+///
+/// For example:

-/// Returns the list of `RouteMatch` corresponding to the given [loc]. For
-/// example, for a given [loc]`/a/b/c/d`, this function will return the list of
-/// [RouteBase]`[GoRouteA(), GoRouterB(), GoRouteC(), GoRouterD()]`.
+/// Returns the list of `RouteMatch` corresponding to the given [loc].
+///
+/// For example, for a given [loc]`/a/b/c/d`, this function will return the list of
+/// [RouteBase]`[GoRouteA(), GoRouterB(), GoRouteC(), GoRouterD()]`.

	/// Generate the full path (ex: `'/family/:fid/person/:pid'`) of a list of
	/// Generates the full path (ex: `'/family/:fid/person/:pid'`) of a list of

	/// Returns the list of `RouteMatch` corresponding to the given [loc].
	/// Returns the list of `RouteMatch` corresponding to the given `loc`.

Uh oh!

Conversation

ValentinVignal commented Mar 15, 2023

Pre-launch Checklist

Uh oh!

ValentinVignal commented Mar 15, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ValentinVignal commented Mar 16, 2023

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chunhtaiMar 16, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chunhtai commented Mar 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chunhtaiMar 16, 2023•
edited
Loading