Skip to content

docs(use-meta): clarify that returned reference is always stable#228

Merged
cristinecula merged 1 commit into
masterfrom
docs/use-meta-jsdoc
Mar 3, 2026
Merged

docs(use-meta): clarify that returned reference is always stable#228
cristinecula merged 1 commit into
masterfrom
docs/use-meta-jsdoc

Conversation

@basilgood
Copy link
Copy Markdown
Contributor

Summary

  • Rewrites the useMeta JSDoc to make it explicit that the returned object identity never changes (===), only its properties are mutated in-place
  • The previous doc ("copies properties into a memoized object") didn't convey the key invariant — that the reference is always stable — which led to confusion during code review

@cristinecula cristinecula self-requested a review March 3, 2026 10:58
@cristinecula cristinecula self-assigned this Mar 3, 2026
@cristinecula cristinecula merged commit e676d65 into master Mar 3, 2026
2 checks passed
@cristinecula cristinecula deleted the docs/use-meta-jsdoc branch March 3, 2026 10:58
@github-actions
Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 6.20.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants