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: tweak snapshot example #12426

Merged
merged 3 commits into from
Jul 15, 2024
Merged

docs: tweak snapshot example #12426

merged 3 commits into from
Jul 15, 2024

Conversation

Rich-Harris
Copy link
Member

While adding to the docs in #12413 I noticed that our $state.snapshot example could be a little clearer:

  • it's not actually using $state.snapshot, it's using $state 🤦
  • the point being made gets a bit lost in all the punctuation. if we want to show an example of changing a specific property deep inside a frozen array, we should make it realistic, but I think it's much better to get straight to the point
  • Prettier borks it up

(Obviously there'll be a merge conflict between this and #12413; can fix that later.)

I'm aware that the example here is meant to be a continuation of the one above, but I'd like to change that too in a follow-up PR.

Copy link

changeset-bot bot commented Jul 12, 2024

⚠️ No Changeset found

Latest commit: ad20f48

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

@Rich-Harris Rich-Harris changed the title Tweak snapshot example docs: tweak snapshot example Jul 12, 2024
@dummdidumm dummdidumm merged commit efe3b39 into main Jul 15, 2024
9 checks passed
@dummdidumm dummdidumm deleted the tweak-snapshot-example branch July 15, 2024 06:59
trueadm pushed a commit that referenced this pull request Jul 16, 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.

2 participants