Add comment

markuplint · Feb 10, 2024 · d253aea · d253aea
1 parent 8757d62
commit d253aea
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/packages/@markuplint/selector/src/is.ts b/packages/@markuplint/selector/src/is.ts
@@ -12,6 +12,15 @@ export function isNonDocumentTypeChildNode(
 	return 'previousElementSibling' in node && 'nextElementSibling' in node;
 }
 
+/**
+ * Checks if the given element is a pure HTML element.
+ *
+ * If a pure HTML element, `localName` returns lowercase,
+ * `nodeName` returns uppercase.
+ *
+ * @param el The element to check.
+ * @returns Returns true if the element is a pure HTML element, otherwise returns false.
+ */
 export function isPureHTMLElement(
 	// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 	el: Element,