documentation

tjol · Dec 7, 2024 · 596424b · 596424b
1 parent 646a94f
commit 596424b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## Unreleased
+
+- The parser has been updated to the newest version of the KDLv2 spec (TBC)
+  * multi-line strings now use `"""` instead of `"`
+  * slashdash behaviour has been harmonized
+- `kdl_unescape_v` now applies the single-line-string rules for KDLv2; use
+  `kdl_unescape_multi_line` for multi-line rules.
+
 ## v0.2.0 (2024-10-13)
 
 Bug fixed:

diff --git a/doc/ckdl-api.rst b/doc/ckdl-api.rst
@@ -155,12 +155,20 @@ String behaviour varies by KDL version:
 
 .. c:function:: kdl_owned_string kdl_unescape_v(kdl_version version, kdl_str const* s)
 
-    Resolve backslash escape sequences
+    Resolve backslash escape sequences.
 
     :param version: The KDL version to use
-    :param s: A string that might have been surrounded by ``""`` in a KDL file
+    :param s: A string that might have been surrounded by ``"`` in a KDL file
     :return: The string with all backslash escapes replaced
 
+.. c:function:: kdl_owned_string kdl_unescape_multi_line(kdl_version version, kdl_str const* s)
+
+    Dedent the multi-line string and resolve backslash escape sequences.
+
+    :param version: The KDL version to use
+    :param s: A string that might have been surrounded by ``"""`` in a KDL file (in KDLv1: ``"``)
+    :return: The dedented string with all backslash escapes replaced
+
 
 KDL Values
 ^^^^^^^^^^