summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorGravatar Nicolas Petton2021-03-08 18:27:15 +0100
committerGravatar Nicolas Petton2021-03-08 18:27:15 +0100
commit68e9270ebe205296ab9868e1f8722a1b572404c3 (patch)
treee07fef0c5808bb90d54477c76d5a24cf59606d58
parent7c5042417f893d97f5825773beea8946fc638f35 (diff)
downloadnroam-68e9270ebe205296ab9868e1f8722a1b572404c3.tar.gz
nroam-68e9270ebe205296ab9868e1f8722a1b572404c3.zip
Fix docstrings
* nroam-backlinks.el (nroam-backlinks-section): * nroam-unlinked.el (nroam-unlinked-section): * nroam.el (nroam-setup-maybe): (nroam-update): (nroam--org-roam-file-p): (nroam--update-maybe): Fix docstrings according to `checkdoc'.
-rw-r--r--nroam-backlinks.el2
-rw-r--r--nroam-unlinked.el2
-rw-r--r--nroam.el8
3 files changed, 6 insertions, 6 deletions
diff --git a/nroam-backlinks.el b/nroam-backlinks.el
index fe90289..04497b1 100644
--- a/nroam-backlinks.el
+++ b/nroam-backlinks.el
@@ -37,7 +37,7 @@
(nroam-register-section #'nroam-backlinks-section))
(defun nroam-backlinks-section ()
- "Insert org-roam backlinks for the current buffer."
+ "Insert `org-roam' backlinks for the current buffer."
(let* ((backlinks (nroam-backlinks--get-backlinks))
(groups (seq-reverse (nroam-backlinks--group backlinks))))
(nroam-backlinks--insert-heading (seq-length backlinks))
diff --git a/nroam-unlinked.el b/nroam-unlinked.el
index d2d4d50..d36e80a 100644
--- a/nroam-unlinked.el
+++ b/nroam-unlinked.el
@@ -36,7 +36,7 @@
(nroam-register-section #'nroam-unlinked-section))
(defun nroam-unlinked-section ()
- "Insert org-roam unlinked references for the current buffer."
+ "Insert `org-roam' unlinked references for the current buffer."
(nroam-unlinked--insert-heading)
(if nroam-unlinked-show-references
(nroam-unlinked--insert-references)
diff --git a/nroam.el b/nroam.el
index 11e6149..b0d9951 100644
--- a/nroam.el
+++ b/nroam.el
@@ -88,7 +88,7 @@ Make the region inserted by BODY read-only, and marked with
;;;###autoload
(defun nroam-setup-maybe ()
- "Setup nroam for the current buffer iff an org-roam buffer."
+ "Setup nroam for the current buffer iff an `org-roam' buffer."
(when (nroam--org-roam-file-p)
(nroam-mode)))
@@ -131,14 +131,14 @@ Make the region inserted by BODY read-only, and marked with
;;;###autoload
(defun nroam-update ()
- "Update org-roam sections for the current buffer."
+ "Update `org-roam' sections for the current buffer."
(interactive)
(nroam--setup-markers)
(nroam--prune)
(nroam--insert))
(defun nroam--org-roam-file-p ()
- "Return non-nil if the current buffer is an org-roam buffer."
+ "Return non-nil if the current buffer is an `org-roam' buffer."
(org-roam--org-roam-file-p))
(defun nroam--point-at-section-p ()
@@ -149,7 +149,7 @@ Make the region inserted by BODY read-only, and marked with
(<= beg (point) end))))
(defun nroam--update-maybe ()
- "Update backlinks when in nroam-mode."
+ "Update backlinks when nroam is enabled."
(when nroam-mode
(nroam-update)))