Handle escaped character references in protocol comments

Cirras · Nov 14, 2024 · 33d582d · 33d582d
1 parent f42095a
commit 33d582d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Generated code now sets `EoWriter.string_sanitization_mode` during serialization.
   - For more information, see
     [Chunked Reading: Sanitization](https://github.com/Cirras/eo-protocol/blob/master/docs/chunks.md#sanitization).
+- Escaped character references appearing in docstrings and downstream generated documentation.
 
 ## [1.1.1] - 2024-08-22
 

diff --git a/protocol_code_generator/util/xml_utils.py b/protocol_code_generator/util/xml_utils.py
@@ -1,4 +1,5 @@
 from xml.etree.ElementTree import Element
+from html import unescape
 
 
 def get_instructions(element):
@@ -32,7 +33,7 @@ def get_text(element):
                 raise RuntimeError(f'Unexpected text content "{text}"')
             result = text
 
-    return result if result else None
+    return unescape(result) if result else None
 
 
 def get_string_attribute(element, name, default_value=None):