Skip to content
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

fix: correct documentation for beforeNavigate #11300

Merged
merged 3 commits into from
Dec 13, 2023

Conversation

Rich-Harris
Copy link
Member

fixes #8597 and #8625

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Dec 13, 2023

🦋 Changeset detected

Latest commit: 391ae10

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@dummdidumm
Copy link
Member

dummdidumm commented Dec 13, 2023

For ergonomic reasons (not creating another 1.x release and another merge in version-2 which will conflict blabla etc), should we just open this against version-2? I doubt many people will miss this documentation from the jsdoc hovering in practise, especially since it will be on the website anyway.
Change itself looks good 👍

@Rich-Harris
Copy link
Member Author

i figure releases are free, no harm in squeezing in one more 1.x patch. shouldn't cause any merge conflicts

@Rich-Harris Rich-Harris merged commit f82df6c into master Dec 13, 2023
12 checks passed
@Rich-Harris Rich-Harris deleted the fix-before-navigate-docs branch December 13, 2023 19:49
@github-actions github-actions bot mentioned this pull request Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

beforeNavigate doesn't trigger default browser behaviour as-per the docs
2 participants