summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
Diffstat (limited to 'API.md')
-rw-r--r--API.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/API.md b/API.md
index 3003a5c..858d4e6 100644
--- a/API.md
+++ b/API.md
@@ -400,3 +400,8 @@ this function may be deprecated if it isn't needed anymore.
#### Return value
A string which contains a complete formspec definition building the widget.
+
+#### Note
+When you use this function to build a formspec string, do not use identifiers
+beginning with `doc_widget_text` to avoid naming collisions, as this function
+makes use of such identifiers internally.