branch: externals/yaml
commit e32ef2f5e50fd98f78f531bd08540c273da15a95
Author: Zachary Romero <zacrom...@posteo.net>
Commit: Zachary Romero <zacrom...@posteo.net>
add note to yaml-parse-string-with-pos function
---
yaml.el | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/yaml.el b/yaml.el
index c92d42b689..cfae27374d 100644
--- a/yaml.el
+++ b/yaml.el
@@ -1115,7 +1115,10 @@ value. It defaults to the symbol :false."
res))
(defun yaml-parse-string-with-pos (string)
- "Parse the YAML value in STRING, storing positions as text properties."
+ "Parse the YAML value in STRING, storing positions as text properties.
+
+NOTE: This is an experimental feature and may experience API
+changes in the future."
(let ((yaml--parsing-store-position t))
(yaml-parse-string string
:object-type 'alist
