chore: update comments for proxyRefs

yyx990803 · yyx990803 · commit 0ae73160088a · 2024-07-17T18:01:13.000+08:00
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.

Original file line number	Diff line number	Diff line change
`@@ -250,11 +250,9 @@ const shallowUnwrapHandlers: ProxyHandler<any> = {`
`250`	`250`	`}`
`251`	`251`
`252`	`252`	`/**`
`253`		`- * Returns a reactive proxy for the given object.`
`254`		`- *`
`255`		`- * If the object already is reactive, it's returned as-is. If not, a new`
`256`		`- * reactive proxy is created. Direct child properties that are refs are properly`
`257`		`- * handled, as well.`
	`253`	`+ * Returns a proxy for the given object that shallowly unwraps properties that`
	`254`	`+ * are refs. If the object already is reactive, it's returned as-is. If not, a`
	`255`	`+ * new reactive proxy is created.`
`258`	`256`	`*`
`259`	`257`	`* @param objectWithRefs - Either an already-reactive object or a simple object`
`260`	`258`	`* that contains refs.`