chore: update comments for proxyRefs

vuejs · Jul 17, 2024 · 0ae7316 · 0ae7316
1 parent f15ba2c
commit 0ae7316
Showing 1 changed file with 3 additions and 5 deletions.
diff --git a/packages/reactivity/src/ref.ts b/packages/reactivity/src/ref.ts
@@ -250,11 +250,9 @@ const shallowUnwrapHandlers: ProxyHandler<any> = {
 }
 
 /**
- * Returns a reactive proxy for the given object.
- *
- * If the object already is reactive, it's returned as-is. If not, a new
- * reactive proxy is created. Direct child properties that are refs are properly
- * handled, as well.
+ * Returns a proxy for the given object that shallowly unwraps properties that
+ * are refs. If the object already is reactive, it's returned as-is. If not, a
+ * new reactive proxy is created.
  *
  * @param objectWithRefs - Either an already-reactive object or a simple object
  * that contains refs.