From: Evan You <evan@vuejs.org>
Date: Wed, 17 Jul 2024 10:01:13 +0000 (+0800)
Subject: chore: update comments for proxyRefs
X-Git-Tag: v3.5.0-alpha.3~10
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0ae73160088acbf1e597a9a3d7486b6f5eab7649;p=thirdparty%2Fvuejs%2Fcore.git

chore: update comments for proxyRefs
---

diff --git a/packages/reactivity/src/ref.ts b/packages/reactivity/src/ref.ts
index 68ccdc3103..a478ff4642 100644
--- 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.