From 5a53c0bfc65d8966ee0874939dfe449e372330f7 Mon Sep 17 00:00:00 2001
From: Syndamia <kamen@syndamia.com>
Date: Tue, 31 Dec 2024 11:55:09 +0200
Subject: doc(single): Add information on current limitation

---
 single.awk | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'single.awk')

diff --git a/single.awk b/single.awk
index 0d402fd..78ae873 100644
--- a/single.awk
+++ b/single.awk
@@ -37,6 +37,14 @@
 #         [ ] Link destination (<link> inside anchors)
 #         [ ] Nested links
 # No character classes, since they aren't supported on every system
+#
+# Limitations:
+# - definition lists always contain one element, i.e. multiple definitions
+#   aren't merged into the same list
+# - emphasis which isn't surrounded by blanks is still treated as emphasis
+#   e.g. "some_text_here" will become "some<em>text</em>here"
+# - emphasis inside inline code block is still converted to HTML
+# - backticks inside `` emphasis blocks aren't escaped
 
 BEGIN {
 	prev_blankline = blankline = 1
-- 
cgit v1.3.1-23-gd82d