branch: externals/dape
commit e79a7b9ebb9543efd3307bc28f530f1f97f8f2b0
Author: Daniel Pettersson <dan...@dpettersson.net>
Commit: Daniel Pettersson <dan...@dpettersson.net>
Improve documentation of `dape--config-from-string'
---
dape.el | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/dape.el b/dape.el
index b4c7f24db7..725092b0e7 100644
--- a/dape.el
+++ b/dape.el
@@ -4292,7 +4292,9 @@ configurations: %s"
(copy-tree base-config)))))
(defun dape--config-from-string (str &optional loose-parsing)
- "Parse list of name and config from STR.
+ "Return list of ALIST-KEY CONFIG from STR.
+Expects STR format of \”ALIST-KEY PLIST-KEY PLIST-VALUE\” etc.
+Where ALIST-KEY exists in `dape-configs'.
If LOOSE-PARSING is non nil ignore arg parsing failures."
(let ((buffer (current-buffer))
name read-config base-config)
