Skip to content

Conversation

@ignatiusmb
Copy link
Member

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 pnpx changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Jan 18, 2022

⚠️ No Changeset found

Latest commit: c8b7315

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@netlify
Copy link

netlify bot commented Jan 18, 2022

✔️ Deploy Preview for kit-demo ready!

🔨 Explore the source changes: c8b7315

🔍 Inspect the deploy log: https://app.netlify.com/sites/kit-demo/deploys/61e786ea691b7500071709af

😎 Browse the preview: https://deploy-preview-3395--kit-demo.netlify.app/

@benmccann benmccann added the documentation Improvements or additions to documentation label Jan 18, 2022

An object containing zero or more of the following values:

- `register` - set to `false` to disable automatic service worker registration
Copy link
Member

@benmccann benmccann Jan 18, 2022

Choose a reason for hiding this comment

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

the current wording is slightly ambiguous as it can be read as "it is set to false so that it will be disabled" or "you can set it to false to disable"

Suggested change
- `register` - set to `false` to disable automatic service worker registration
- `register` - whether to enable automatic service worker registration. Default is `true`

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm following a similar wording style to the prerender.enabled config, and we don't really mention the default value for the config anywhere since it's already displayed in the code block at the start, so I don't think the last part is necessary

@Rich-Harris Rich-Harris merged commit 3e4f3ba into master Jan 19, 2022
@Rich-Harris Rich-Harris deleted the service-worker-register branch January 19, 2022 03:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants