(docs): org-roam.el clarify documentation (#716)
Fix typo, reword docstring, remove decorative ellipses
This commit is contained in:
parent
f9a9f15a8b
commit
91c905d7e3
1 changed files with 3 additions and 3 deletions
|
@ -540,7 +540,7 @@ Tags are obtained via:
|
||||||
(`(,(pred symbolp) . ,_)
|
(`(,(pred symbolp) . ,_)
|
||||||
(apply #'cl-sort (push tags org-roam-tag-sort)))
|
(apply #'cl-sort (push tags org-roam-tag-sort)))
|
||||||
(wrong-type (signal 'wrong-type-argument
|
(wrong-type (signal 'wrong-type-argument
|
||||||
`((booleanp (list symbolp …))
|
`((booleanp (list symbolp))
|
||||||
,wrong-type))))))
|
,wrong-type))))))
|
||||||
|
|
||||||
(defun org-roam--cite-prefix (ref)
|
(defun org-roam--cite-prefix (ref)
|
||||||
|
@ -677,7 +677,7 @@ whose title is 'Index'."
|
||||||
|
|
||||||
;;;; org-roam-find-ref
|
;;;; org-roam-find-ref
|
||||||
(defun org-roam--get-ref-path-completions (&optional interactive filter)
|
(defun org-roam--get-ref-path-completions (&optional interactive filter)
|
||||||
"Return a alist of refs to absolute path of Org-roam files.
|
"Return an alist of refs to absolute path of Org-roam files.
|
||||||
When `org-roam-include-type-in-ref-path-completions' and
|
When `org-roam-include-type-in-ref-path-completions' and
|
||||||
INTERACTIVE are non-nil, format the car of the
|
INTERACTIVE are non-nil, format the car of the
|
||||||
completion-candidates as 'type:ref'.
|
completion-candidates as 'type:ref'.
|
||||||
|
@ -731,7 +731,7 @@ Return nil if the file does not exist."
|
||||||
(buffer-list)))
|
(buffer-list)))
|
||||||
|
|
||||||
(defun org-roam--file-path-from-id (id)
|
(defun org-roam--file-path-from-id (id)
|
||||||
"The file path for an Org-roam file, with identifier ID."
|
"Return path for Org-roam file with ID."
|
||||||
(file-truename
|
(file-truename
|
||||||
(let* ((ext (or (car org-roam-file-extensions)
|
(let* ((ext (or (car org-roam-file-extensions)
|
||||||
"org"))
|
"org"))
|
||||||
|
|
Loading…
Reference in a new issue