summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-02-28 00:31:19 +0200
committerThanos Apollo <[email protected]>2024-02-28 00:31:19 +0200
commit37b3ac8f6bed76d9ad3d84d22ae491f37c1587f5 (patch)
tree050026546e69c09d5bf2a07516f60b9028afbe3d
parentaa15b5022fc76204c7e1e34d9181adbffb4f6a6b (diff)
gnosis-db-schema-extras: Add comments
Explain the reason behind the naming conventions used
-rw-r--r--gnosis.el11
1 files changed, 11 insertions, 0 deletions
diff --git a/gnosis.el b/gnosis.el
index e707ac6..8244496 100644
--- a/gnosis.el
+++ b/gnosis.el
@@ -1394,8 +1394,19 @@ name and all notes formatted as nested lists"
(defvar gnosis-db-schema-extras '([(id integer :primary-key :not-null)
(extra-notes string)
+ ;; Despite the name 'images', this
+ ;; is a single string value. At
+ ;; first it was designed to hold a
+ ;; list of strings for image paths,
+ ;; but it was changed to just a
+ ;; string to hold a single image
+ ;; path.
(images string)
+ ;; Extra image path to show after review
(extra-image string)]
+ ;; Note that the value of the images
+ ;; above is PATH inside
+ ;; `gnosis-images-dir'
(:foreign-key [id] :references notes [id]
:on-delete :cascade)))