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

#each documentation should be more helpful and direct about keys #392

Open
zzolo opened this issue Dec 22, 2018 · 0 comments
Open

#each documentation should be more helpful and direct about keys #392

zzolo opened this issue Dec 22, 2018 · 0 comments

Comments

@zzolo
Copy link

zzolo commented Dec 22, 2018

The current documentation for {#each} block only mentions keyed each blocks as a note. To me, this is a serious problem, since not using a key in many cases causes broken/unexpected results when the state/data is updated.

I think the following should happen:

  • The keyed documentation should be included in the #each block documentation
  • There should be clear documentation about how not using a key can lead to unexpected behavior, and is basically necessary for updating data
  • (optional) The prime example for the documentation should involve keys, and the later example can talk about how not using a key can be more performant but may lead to unexpected results.

References:

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

No branches or pull requests

1 participant