Add comments

Author: SharmaineLim

tbx/core/utils/formatting.py

@@ -4,7 +4,9 @@
 def convert_bold_links_to_pink(html_text):
     """Convert <b> tags inside links into <span class="text-coral">."""
     soup = BeautifulSoup(html_text, "html.parser")
+    # Limit the changes to anchor tags (<a>).
     for anchor_tag in soup.find_all("a"):
+        # Find all bold tags (<b>) and convert them to span tags (<span>).
         for bold_tag in anchor_tag.find_all("b"):
             tag_content = "".join([str(c) for c in bold_tag.contents])
             html_text = html_text.replace(
@@ -16,7 +18,9 @@ def convert_bold_links_to_pink(html_text):
 def convert_italic_links_to_purple(html_text):
     """Convert <i> tags inside links into <span class="text-nebuline">."""
     soup = BeautifulSoup(html_text, "html.parser")
+    # Limit the changes to anchor tags (<a>).
     for anchor_tag in soup.find_all("a"):
+        # Find all italic tags (<i>) and convert them to span tags (<span>).
         for italic_tag in anchor_tag.find_all("i"):
             tag_content = "".join([str(c) for c in italic_tag.contents])
             html_text = html_text.replace(