Skip to content

Commit 63bce61

Browse files
committed
Adjust documentation for function
1 parent 8be4955 commit 63bce61

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

packages/utils/src/browser.ts

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -159,12 +159,9 @@ export function getDomElement<E = any>(selector: string): E | null {
159159
}
160160

161161
/**
162-
* Given
163-
*
164-
* Given a child DOM element, returns a query-selector statement describing that
165-
* and its ancestors
166-
* e.g. [HTMLElement] => body > div > input#foo.btn[name=baz]
167-
* @returns generated DOM path
162+
* Given a child DOM element, returns the component name of the element.
163+
* If the component name does not exist, this function will fallback to `htmlTreeAsString`
164+
* e.g. [HTMLElement] => MyComponentName
168165
*/
169166
export function getElementIdentifier(
170167
elem: unknown,

0 commit comments

Comments
 (0)