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: shorter explanation of shallow tracking #10746

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Rich-Harris
Copy link
Member

We devote way too much space to this nuance that doesn't really matter day-to-day. It's worth briefly explaining that values are tracked shallowly rather than deeply, but it's surprisingly hard to contrive a situation where this distinction actually matters. It doesn't warrant this much real estate.

Copy link

changeset-bot bot commented Mar 10, 2024

⚠️ No Changeset found

Latest commit: d1aa412

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
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.

I disagree - this has come up multiple times in Discord, I think it's fine to give it an extra example. With just the callout, I would have multiple questions when reading this as a user:

  • what is user? Did I miss a previous example where user was used? -> this is why an extra code example is nice (also to explain the derived nuance)
  • what does "shallowly" mean exactly here? (as a non-native speaker that word reads special)
  • why does logging change the behavior? Why does JSON serialisation? -> either we explain why, or we just leave it out
  • "oh so I can use inspect instead for my use case" -> click -> "oh this is dev time only" --> the previous sentence made it clear from the start that this is dev only

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.

None yet

2 participants