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

docs: update $effect examples #15463

Merged
merged 7 commits into from
Apr 9, 2025
Merged

docs: update $effect examples #15463

merged 7 commits into from
Apr 9, 2025

Conversation

benmccann
Copy link
Member

Updates examples to remove things that could possibly be confusing or misleading

Mostly replaces console.log with writes to canvas. Users should typically reach for $inspect instead of console.log

Also replaces the example that was setting count inside setInterval inside an $effect. I tried telling a generally advanced user yesterday that you shouldn't set state inside an $effect and he responded "what are you talking about? that's what one of the very first examples shows..."

Copy link

changeset-bot bot commented Mar 6, 2025

⚠️ No Changeset found

Latest commit: 120a062

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

@svelte-docs-bot
Copy link

Copy link
Contributor

github-actions bot commented Mar 6, 2025

Playground

pnpm add https://pkg.pr.new/svelte@15463

@Rich-Harris
Copy link
Member

Also replaces the example that was setting count inside setInterval inside an $effect. I tried telling a generally advanced user yesterday that you shouldn't set state inside an $effect

Setting count inside a setInterval isn't 'setting state inside an effect', it's setting state inside an interval which is a different (and totally fine) thing. We should revert that change

@Rich-Harris
Copy link
Member

preview deployment is failing but i suspect it's unrelated

@Rich-Harris Rich-Harris merged commit 0ff3d74 into main Apr 9, 2025
13 checks passed
@Rich-Harris Rich-Harris deleted the effect-examples branch April 9, 2025 02:40
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.

2 participants