add comments to describe logic

Author: hbuchel

src/components/MDXComponents/MDXHeading.tsx

@@ -6,11 +6,15 @@ export const MDXHeading = (props) => {
   const { level, children } = props;
   let href = '';
 
+  /* Test if children element is not a string before creating the url slug */
   if (children && typeof children != 'string') {
     let newChildren = '';
+    /* Test if child element is a single object */
     if (typeof children == 'object' && children.props?.children) {
       newChildren = children.props.children;
     } else {
+      /* If not a single object, we expect an array of
+      elements and loop through them */
       for (let i = 0; i < children.length; i++) {
         if (typeof children[i] == 'string') {
           newChildren = newChildren + children[i];
@@ -21,6 +25,7 @@ export const MDXHeading = (props) => {
     }
     href = `${slug(newChildren)}`;
   } else {
+    /* If children element is a string, use that to create the url slug */
     href = `${slug(children)}`;
   }