[go_router] Add documentation to some methods in matching.dart #3462
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I would think this is a version exempt ? |
chunhtai
reviewed
Mar 15, 2023
| @@ -76,8 +83,11 @@ class RouteMatchList { | |||
|
|
|||
| final List<RouteMatch> _matches; | |||
|
|
|||
| /// the full path pattern that matches the uri. | |||
| /// /family/:fid/person/:pid | |||
| /// the full path pattern that matches the uri. For example: | |||
There was a problem hiding this comment.
Suggested change
| /// the full path pattern that matches the uri. For example: | |
| /// The full path pattern that matches the uri. | |
| /// | |
| /// For example: |
Comment on lines
172
to
174
| /// 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()]`. |
There was a problem hiding this comment.
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()]`. |
| /// Generate the full path (ex: `'/family/:fid/person/:pid'`) of a list of | ||
| /// [RouteMatch]. | ||
| /// | ||
| /// This methods considers that [matches] is ordered accorresponding to how |
There was a problem hiding this comment.
I can't quite parse this sentence
There was a problem hiding this comment.
I hope docs: Better documentation makes it clearer
| /// | ||
| /// - [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 |
Should the label "override: no versioning needed" be added to this PR ? Or should I create a new version? |
chunhtai
added
the
override: no versioning needed
chunhtai
approved these changes
Mar 16, 2023
| @@ -58,6 +60,34 @@ class RouteMatchList { | |||
| static RouteMatchList empty = | |||
| RouteMatchList(<RouteMatch>[], Uri.parse(''), const <String, String>{}); | |||
|
|
|||
| /// Generate the full path (ex: `'/family/:fid/person/:pid'`) of a list of | |||
There was a problem hiding this comment.
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 |
| /// 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 |
There was a problem hiding this comment.
Maybe:
The [matches] must be the in same order of how GoRoutes are matched.
For example, if the routes structure is ...
| @@ -159,6 +194,18 @@ class MatcherError extends Error { | |||
| } | |||
| } | |||
|
|
|||
| /// Returns the list of `RouteMatch` corresponding to the given [loc]. | |||
There was a problem hiding this comment.
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`. |
| @@ -159,6 +194,18 @@ class MatcherError extends Error { | |||
| } | |||
| } | |||
|
|
|||
| /// 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 | |||
|
cc @johnpryan for secondary review |
johnpryan
approved these changes
Mar 16, 2023
11 tasks
chunhtai
added
the
autosubmit
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Mar 21, 2023
nploi
pushed a commit
to nploi/packages
that referenced
this pull request
Jul 16, 2023
…er#3462) [go_router] Add documentation to some methods in matching.dart
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was investigating how to fix flutter/flutter#113032 (I will soon public a design proposition as I think the entire
RouteMatchListstructure 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
dart format.)[shared_preferences]pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.mdto add a description of the change, following repository CHANGELOG style.///).If you need help, consider asking for advice on the #hackers-new channel on Discord.