branch: elpa/emacsql
commit fbda94e6b57cd5806fe45ae4efbd07e380933c7c
Author: Jonas Bernoulli <jo...@bernoul.li>
Commit: Jonas Bernoulli <jo...@bernoul.li>
Improve some doc-strings.
---
emacsql-compiler.el | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/emacsql-compiler.el b/emacsql-compiler.el
index 40204acab9..2fb55407f3 100644
--- a/emacsql-compiler.el
+++ b/emacsql-compiler.el
@@ -161,7 +161,7 @@
"Cache used to memoize `emacsql-prepare'.")
(defvar emacsql--vars ()
- "For use with `emacsql-with-params'.")
+ "Used within `emacsql-with-params' to collect parameters.")
(defun emacsql-sql-p (thing)
"Return non-nil if THING looks like a prepared statement."
@@ -200,7 +200,9 @@ which will be combined with variable definitions."
(cons (concat ,prefix (progn ,@body)) emacsql--vars))))
(defun emacsql--!param (thing &optional kind)
- "Only use within `emacsql-with-params'!"
+ "Parse, escape, and store THING.
+If optional KIND is not specified, then try to guess it.
+Only use within `emacsql-with-params'!"
(cl-flet ((check (param)
(when (and kind (not (eq kind (cdr param))))
(emacsql-error
@@ -293,7 +295,8 @@ which will be combined with variable definitions."
(mapconcat #'expr idents ", ")))
(defun emacsql--*combine (prepared)
- "Only use within `emacsql-with-params'!"
+ "Append parameters from PREPARED to `emacsql--vars', return the string.
+Only use within `emacsql-with-params'!"
(cl-destructuring-bind (string . vars) prepared
(setf emacsql--vars (nconc emacsql--vars vars))
string))
