Skip to content

[go_router_builder] Fix typo in README.md #7137

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

Closed
wants to merge 1 commit into from

Conversation

riscait
Copy link

@riscait riscait commented Jul 16, 2024

Changed .go to .push.
It is .push that returns Future, not .go.

Pre-launch Checklist

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

Comment on lines 386 to 387
To run tests in examples, run `flutter test` from `packages/go_router_builder/example`. No newline at end of file
To run tests in examples, run `flutter test` from `packages/go_router_builder/example`.
Copy link
Author

Choose a reason for hiding this comment

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

It appears that the formatter has added a new line at the end of the file.

Copy link
Contributor

@stuartmorgan-g stuartmorgan-g left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution!

The way to fix incorrect code samples is to adopt code excerpts, which fixes the underlying problem rather than one specific symptom, and also ensures it doesn't regress as the package evolves.

@riscait
Copy link
Author

riscait commented Jul 17, 2024

@stuartmorgan
Thanks for the confirmation.
I looked at the code excerpts. Does this mean I need to link to the actual code?

I searched the repositories and didn't see anywhere that uses await SomeRouter().push(context).

Does this mean that the main.dart of example must be edited for this PR to be merged?

@stuartmorgan-g
Copy link
Contributor

If there are things that we want to show in the README but not the example app, they can be sourced from a readme_excepts.dart file made for that purpose (example).

@chunhtai
Copy link
Contributor

chunhtai commented Aug 1, 2024

I am going to close this one since there is another pr that use code-excerpts #7280

@chunhtai chunhtai closed this Aug 1, 2024
@riscait riscait deleted the patch-1 branch September 24, 2024 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants