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: clarify $effect.tracking #14821

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sacrosanctic
Copy link
Contributor

@sacrosanctic sacrosanctic commented Dec 24, 2024

I saw the do not edit warning. I couldn't figure out where these changes are supposed to go. So I'm just soliciting feedback from the maintainers first.

link to preview: https://svelte-dev-git-preview-svelte-14821-svelte.vercel.app/docs/svelte/$effect#$effect.tracking

tracking context to reactive context

This term is not mentioned anywhere other than in $effect.tracking section, which is a cyclical definition.

Update description

image

Changed to align to similar features like browser.

true if the app is running in the browser.
https://svelte.dev/docs/kit/$app-environment#browser

The use of an if guard in the example

There are a lot of open/close brackets and it's hard to see where the $effect.tracking() start and end.

An illustrative example to include all places where this is active

like this one provided by #14757 (comment)


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
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

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

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-svelte-14821-svelte.vercel.app/

this is an automated message

Copy link
Contributor

Playground

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

Copy link

changeset-bot bot commented Dec 24, 2024

⚠️ No Changeset found

Latest commit: 18d69f7

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

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.

2 participants