From 25d1243edd2e26c4637e2f3e3eabc79acdcb3bed Mon Sep 17 00:00:00 2001 From: Gabriel Horner Date: Fri, 10 Jan 2025 12:41:54 -0500 Subject: [PATCH] chore: update docstrings in kv-entity Also update other :import-type to be keywords like other values --- deps/db/src/logseq/db/frontend/kv_entity.cljs | 20 +++++++++---------- src/main/frontend/handler/import.cljs | 7 ++++--- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/deps/db/src/logseq/db/frontend/kv_entity.cljs b/deps/db/src/logseq/db/frontend/kv_entity.cljs index 3845750a90..1d078c759e 100644 --- a/deps/db/src/logseq/db/frontend/kv_entity.cljs +++ b/deps/db/src/logseq/db/frontend/kv_entity.cljs @@ -3,22 +3,22 @@ (:require [logseq.common.defkeywords :refer [defkeywords]])) (defkeywords - :logseq.kv/db-type {:doc ":kv/value = \"db\" if it's a db-graph"} - :logseq.kv/graph-uuid {:doc "store graph-uuid if it's a rtc enabled graph" + :logseq.kv/db-type {:doc "Set to \"db\" if it's a db-graph"} + :logseq.kv/graph-uuid {:doc "Store graph-uuid if it's a rtc enabled graph" :rtc {:rtc/ignore-entity-when-init-upload true :rtc/ignore-entity-when-init-download true}} - :logseq.kv/import-type {:doc ":sqlite-db if import from sqlite. - FIXME: any other values?"} - :logseq.kv/imported-at {:doc "graph-import time"} + :logseq.kv/import-type {:doc "If graph is imported, identifies how a graph is imported including which UI or CLI import process. CLI scripts can set this to a custom value. + UI values include :file-graph and :sqlite-db and CLI values start with :cli e.g. :cli/default."} + :logseq.kv/imported-at {:doc "Time if graph is imported"} :logseq.kv/graph-local-tx {:doc "local rtc tx-id" :rtc {:rtc/ignore-entity-when-init-upload true :rtc/ignore-entity-when-init-download true}} - :logseq.kv/schema-version {:doc "schema version"} - :logseq.kv/graph-created-at {:doc "graph create time"} - :logseq.kv/latest-code-lang {:doc "latest lang used by code-block" + :logseq.kv/schema-version {:doc "Graph's current schema version"} + :logseq.kv/graph-created-at {:doc "Graph's created at time"} + :logseq.kv/latest-code-lang {:doc "Latest lang used by a #Code-block" :rtc {:rtc/ignore-entity-when-init-upload true :rtc/ignore-entity-when-init-download true}} - :logseq.kv/graph-backup-folder {:doc "graph backup-folder" + :logseq.kv/graph-backup-folder {:doc "Backup folder for automated backup feature" :rtc {:rtc/ignore-entity-when-init-upload true :rtc/ignore-entity-when-init-download true}} - :logseq.kv/graph-initial-schema-version {:doc "schema-version when graph created"}) + :logseq.kv/graph-initial-schema-version {:doc "Graph's schema version when created"}) diff --git a/src/main/frontend/handler/import.cljs b/src/main/frontend/handler/import.cljs index 6f59b0bc22..2d95b53b06 100644 --- a/src/main/frontend/handler/import.cljs +++ b/src/main/frontend/handler/import.cljs @@ -234,7 +234,7 @@ (p/do! (persist-db/