summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-01-10 08:55:55 +0200
committerThanos Apollo <[email protected]>2024-01-10 08:55:55 +0200
commitfadc296ccca067a22a929524f62f5007de0d7e1f (patch)
tree9d950d7d3d8883f6cd5fb3c2a4082b1a9e6e27ad
parenteb3fb50be9869d21099b6006d6ab05fd22e6ddf8 (diff)
gnosis-select & gnosis--insert-into: Update docstrings
-rw-r--r--gnosis.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/gnosis.el b/gnosis.el
index 7185add..93ce244 100644
--- a/gnosis.el
+++ b/gnosis.el
@@ -122,7 +122,9 @@
(cl-defun gnosis-select (value table &optional (restrictions '1=1))
- "Select VALUE from TABLE, optionally with RESTRICTIONS."
+ "Select VALUE from TABLE, optionally with RESTRICTIONS.
+
+Use `gnosis-db-init' to initialize `gnosis-db' and create essential directories."
(gnosis-db-init)
(emacsql gnosis-db `[:select ,value :from ,table :where ,restrictions]))
@@ -135,7 +137,9 @@
(emacsql gnosis-db `[:drop-table ,table]))
(cl-defun gnosis--insert-into (table values)
- "Insert VALUES to TABLE."
+ "Insert VALUES to TABLE.
+
+Use `gnosis-db-init' to initialize `gnosis-db' and create essential directories."
(gnosis-db-init)
(emacsql gnosis-db `[:insert :into ,table :values ,values]))