8000 docs: Recommend deriving over syncing state by mithi · Pull Request #15994 · sveltejs/svelte · GitHub
[go: up one dir, main page]

Skip to content

docs: Recommend deriving over syncing state #15994

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

Merged
merged 5 commits into from
May 24, 2025

Conversation

mithi
Copy link
Contributor
@mithi mithi commented May 24, 2025

Closes: #15955

Following the discussion on this issue #15955 , @elliott-with-the-longest-name-on-github encouraged me to submit a PR to update the "money spent / money left" example in the “When not to use $effect section of the docs.

The main change treats spent as the source of truth and derives left from it—simplifying the code, reducing the risk of inconsistencies, and improving the clarity of their relationship.

I also changed let total = 100 to const total = 100 to more clearly conv 8000 ey that the value is intended to remain constant.

Let me know if I missed anything, I'll fix it right away. Thanks!


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

The main change treats spent as the source of truth and derives left from it—simplifying the code, reducing the risk of inconsistencies, and improving the clarity of their relationship.

I also changed let total = 100 to const total = 100 to more clearly convey that the value is intended to remain constant.
Copy link
changeset-bot bot commented May 24, 2025

⚠️ No Changeset found

Latest commit: c66ea04

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

@Rich-Harris
Copy link
Member

This is great, thanks! We can go a step further though — since updateSpent is now just spent = newSpent, we don't actually need to use a function binding for the first input any more, we can just use a normal binding (which I think further cements the 'spent is the source of truth' idea).

Since GitHub's suggestions UI is cumbersome for things that span multiple edits, I'll push up some changes

@Rich-Harris Rich-Harris merged commit 8860ca6 into sveltejs:main May 24, 2025 < 7345 /div>
@mithi mithi changed the title docs: Improve sample code in When not to use $effect section docs: Recommend deriving over syncing state May 27, 2025
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.

Docs Clarification: Deriving vs Syncing Approach for things like two-way bound inputs
2 participants
0