From 4429b6433acad1481dbe0b8573cb6e4522ba2f0c Mon Sep 17 00:00:00 2001
From: Luca Forstner <luca.forstner@sentry.io>
Date: Wed, 25 May 2022 10:22:31 +0000
Subject: [PATCH] Add comment

---
 packages/utils/src/object.ts | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/packages/utils/src/object.ts b/packages/utils/src/object.ts
index e9373797c44f..5957214ecc86 100644
--- a/packages/utils/src/object.ts
+++ b/packages/utils/src/object.ts
@@ -206,6 +206,8 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
 /**
  * Given any object, return the new object with removed keys that value was `undefined`.
  * Works recursively on objects and arrays.
+ *
+ * Attention: This function keeps circular references in the returned object.
  */
 export function dropUndefinedKeys<T>(val: T): T {
   // This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API