added documentation

tovedetered · Apr 5, 2024 · f475b41 · f475b41
1 parent 65c9f65
commit f475b41
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/xmleam/xml_builder.gleam b/src/xmleam/xml_builder.gleam
@@ -103,6 +103,9 @@ pub fn tag(document: XmlBuilder, label: String, contents: String) -> XmlBuilder
   }
 }
 
+/// this is a basic tag that automatically adds the CDATA tag to the XML
+/// NOTE: This same effect can be created with any other tag by adding
+/// <![CDATA[ ... ]]> to the content blocks, this is just for convienence
 pub fn cdata_tag(document: XmlBuilder, label: String, contents: String) {
   let label_empty = string.is_empty(label)
   use <- bool.guard(when: label_empty, return: Error(LabelEmpty))