Skip to content

[go_router] Fix ShellRoute documentation#2621

Merged
auto-submit[bot] merged 3 commits intoflutter:mainfrom
mono0926:fix-shell-route-doc
Sep 26, 2022
Merged

[go_router] Fix ShellRoute documentation#2621
auto-submit[bot] merged 3 commits intoflutter:mainfrom
mono0926:fix-shell-route-doc

Conversation

@mono0926
Copy link
Contributor

Fixed the missing code examples in ShellRoute class - go_router library - Dart API.

image

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alternatively, the following may be okay.

/// final GlobalKey<NavigatorState> _rootNavigatorKey = GlobalKey<NavigatorState>();

Copy link
Contributor

@chunhtai chunhtai left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for catching it

@chunhtai chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 20, 2022
@auto-submit
Copy link
Contributor

auto-submit bot commented Sep 20, 2022

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

@chunhtai chunhtai removed the autosubmit Merge PR when tree becomes green via auto submit App label Sep 20, 2022
@chunhtai
Copy link
Contributor

can you add an entry in ChangeLog.md with ## NEXT?

@mono0926
Copy link
Contributor Author

@chunhtai

Thanks, for the review 👍

can you add an entry in ChangeLog.md with ## NEXT?

I've added it: e08c501

@chunhtai
Copy link
Contributor

@mono0926 Ah the ci suggests publishing a new version, can you publish a new version instead of using the ## NEXT?

@mono0926
Copy link
Contributor Author

@chunhtai

can you publish a new version instead of using the ## NEXT?

done 👌

@chunhtai chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 26, 2022
@auto-submit auto-submit bot merged commit 226da96 into flutter:main Sep 26, 2022
@mono0926 mono0926 deleted the fix-shell-route-doc branch September 27, 2022 03:55
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