Skip to content

docs: Update $props documentation to clarify when prop values are deeply re… #13994

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 4 commits into from
Oct 31, 2024

Conversation

BernieSumption
Copy link
Contributor

This PR updates the $props documentation to clarify when prop values are deeply reactive

In particular, this wording confused me:

Fallback values are not turned into reactive state proxies

As I took it to be an exception, implying that non-fallback values are turned into reactive state proxies. Some experimentation revealed that this is not the case.

Side note: this is my first contribution, I'm new to svelte and reading a lot of docs and happy to help improve them where I'm able. If it would be preferable to discuss docs improvements before opening a PR, please let me know where best to open the discussion.

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.
  • [n/a] 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 28, 2024

⚠️ No Changeset found

Latest commit: 549826a

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@13994

commit: 549826a

Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

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

thank you!

@dummdidumm dummdidumm merged commit 217ef20 into sveltejs:main Oct 31, 2024
8 checks passed
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.

3 participants