Skip to content

docs: add untrack documentation, fixing part of #14058 #14060

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 7 commits into from

Conversation

Ocean-OS
Copy link
Contributor

This adds documentation on untrack. It might need to be put with the svelte reference, I wasn't entirely sure on where to put it.
There is already a (rather small) definition on what it does in the reference, but I think it'd be better to have a clearer definition on what it does and where to use it in the $effect documentation.

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.

Tests and linting

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

Copy link

changeset-bot bot commented Oct 31, 2024

⚠️ No Changeset found

Latest commit: 4e18b58

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

Copy link

pkg-pr-new bot commented Oct 31, 2024

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

commit: 4e18b58

@Ocean-OS
Copy link
Contributor Author

Ocean-OS commented Oct 31, 2024

Just realized that this accidentally merges part of my other PR, #13978. Apologies, I will see how I could remedy this (if #13978 isn't merged soon).

@Rich-Harris
Copy link
Member

Thank you. The documentation really belongs on the untrack function itself — $derived and $effect can link to it, but shouldn't be responsible for illustrating how it works. Opened #14085

@dummdidumm
Copy link
Member

Closing in favor of #14085 - thank you!

@dummdidumm dummdidumm closed this Nov 1, 2024
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.

3 participants