update docstring

Hweinstock · justinmk3 · web-flow · commit 147b9a13e017 · 2024-10-14T10:54:28.000-04:00
Co-authored-by: Justin M. Keyes &lt;jmkeyes@amazon.com&gt;
diff --git a/packages/core/src/test/testUtil.ts b/packages/core/src/test/testUtil.ts
@@ -296,7 +296,7 @@ export function partialDeepCompare<T>(actual: unknown, expected: T, message?: st
     assert.deepStrictEqual(partial, expected, message)
 }
 /**
- * Finds all metrics whose metadata contains this keyword in their key value pairs, as part of the key OR the value.
+ * Asserts that no metrics metadata (key OR value) matches the given regex.
  * @param keyword target substring to search for
  */
 export function assertNotInTelemetryMetadata(keyword: string): void | never {

Original file line number	Diff line number	Diff line change
`@@ -296,7 +296,7 @@ export function partialDeepCompare<T>(actual: unknown, expected: T, message?: st`
`296`	`296`	`assert.deepStrictEqual(partial, expected, message)`
`297`	`297`	`}`
`298`	`298`	`/**`
`299`		`- * Finds all metrics whose metadata contains this keyword in their key value pairs, as part of the key OR the value.`
	`299`	`+ * Asserts that no metrics metadata (key OR value) matches the given regex.`
`300`	`300`	`* @param keyword target substring to search for`
`301`	`301`	`*/`
`302`	`302`	`export function assertNotInTelemetryMetadata(keyword: string): void \| never {`