[elpa] externals/org-remark 23c038138e 4/6: docs: docstrings spell-checked via checkdoc

[ELPA Syncer]

branch: externals/org-remark
commit 23c038138e731913fe896ff8bdd420325cd87166
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    docs: docstrings spell-checked via checkdoc
---
 demo/marginalia.org           | 35 +++++++++++++----------------------
 org-remark-global-tracking.el |  6 +++---
 org-remark.el                 | 24 ++++++++++++------------
 3 files changed, 28 insertions(+), 37 deletions(-)

diff --git a/demo/marginalia.org b/demo/marginalia.org
index 9bd61b0379..4b13b2cc84 100644
--- a/demo/marginalia.org
+++ b/demo/marginalia.org
@@ -1,8 +1,20 @@
+
 * demo
 :PROPERTIES:
-:org-remark-file: ~/src/org-remark/demo/demo.txt
+:org-remark-file: demo.txt
 :END:
 
+** World War I
+:PROPERTIES:
+:org-remark-beg: 633
+:org-remark-end: 644
+:org-remark-id: 598a701e
+:org-remark-label: nil
+:CATEGORY: exam
+:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
+:END:
+
+
 ** Highlight
 :PROPERTIES:
 :org-remark-beg: 26
@@ -104,24 +116,3 @@ Annotation for the 19th centry.
 :CATEGORY: exam
 :org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
 :END:
-
-** World War I
-:PROPERTIES:
-:org-remark-beg: 633
-:org-remark-end: 644
-:org-remark-id: 598a701e
-:org-remark-label: nil
-:CATEGORY: exam
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
-:END:
-
-** particularly iron
-:PROPERTIES:
-:org-remark-beg: 1019
-:org-remark-end: 1036
-:org-remark-id: 895c6dfe
-:org-remark-label: nil
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
-:END:
-
-
diff --git a/org-remark-global-tracking.el b/org-remark-global-tracking.el
index 68151fe573..e2e2e9a50f 100644
--- a/org-remark-global-tracking.el
+++ b/org-remark-global-tracking.el
@@ -32,7 +32,7 @@
 (declare-function org-remark-mode "org-remark")
 
 (defcustom org-remark-notes-file-name "marginalia.org"
-  "Name of the file wher we store highlights and marginal notes.
+  "Name of the file where we store highlights and marginal notes.
 It can be either a string or function.
 
 If it is a string, it should be a file path to the marginal notes
@@ -77,7 +77,7 @@ readable, the function automatically activates `org-remark'."
   "Return a marginal notes file name for the current buffer.
 
 This is the default function for the customizing variable
-`org-remark-notes-file-name' for its funciton option.
+`org-remark-notes-file-name' for its function option.
 
 When the current buffer is visiting a file, the name of marginal
 notes file will be \"FILE-notes.org\", adding \"-notes.org\" as a
@@ -94,7 +94,7 @@ suffix to the file name without the extension."
 
 (defun org-remark-auto-on ()
   "Automatically activates `org-remark-mode' for current buffer when relevant.
-This function is meant to be addd to `find-file-hook' by
+This function is meant to be added to `find-file-hook' by
 `org-remark-global-tracking-mode'."
   (when-let (notes-file (org-remark-notes-get-file-name))
     (when (file-readable-p notes-file)
diff --git a/org-remark.el b/org-remark.el
index 2c8bcf6fcb..f5e5649d47 100644
--- a/org-remark.el
+++ b/org-remark.el
@@ -86,8 +86,8 @@ of the source file.  The `default-directory' is set to the
 directory where the marginal notes file resides.
 
 This means that when the \"Relative file name\" option is
-selected, the source file name will be relative to the marginal
-notes file."
+selected, the source file name recorded in the marginal notes
+file will be relative to it."
   :type '(choice
           (const :tag "Relative file name" file-relative-name)
           (const :tag "Abbreviated absolute file name" abbreviate-file-name)
@@ -337,7 +337,7 @@ When this function is used interactively, it will generate 
a new
 ID, always assuming it is working on a new highlighted text
 region.
 
-A Org headline entry for the highlght will be created in the
+A Org headline entry for the highlight will be created in the
 marginal notes file specified by
 `org-remark-notes-get-file-name'.  If the file does not exist
 yet, it will be created.
@@ -409,7 +409,7 @@ You can customize the name of the marginal notes buffer with
 By default, the cursor will go to the marginal notes buffer for
 further editing.  When VIEW-ONLY is non-nil \(e.g. by passing a
 universal argument with \\[universal-argument]\), you can display
-the marginal notes buffer with the cursour remaining in the
+the marginal notes buffer with the cursor remaining in the
 current buffer.
 
 This function ensures that there is only one cloned buffer for
@@ -577,7 +577,7 @@ This command is identical with passing a universal argument 
to
 NEXT must be either non-nil or nil.
 When non-nil it's for the next; for nil, prev.
 
-This function is internal only and meant to be used by interctive
+This function is internal only and meant to be used by interactive
 commands such as `org-remark-next' and `org-remark-prev'.
 
 Return t if the cursor has moved to next/prev.
@@ -655,7 +655,7 @@ MODE determines whether or not highlight is to be saved in 
the
 marginal notes file.  The expected values are nil, :load and
 :change.
 
-A Org headline entry for the highlght will be created in the
+A Org headline entry for the highlight will be created in the
 marginal notes file specified by `org-remark-notes-get-file-name'.
 If the file does not exist yet, it will be created.
 
@@ -740,8 +740,8 @@ update, the headline text will be kept intact, because the 
user
 might have changed it to their needs.
 
 This function will also add a normal file link as property
-\"org-remark-lilnk\" of the H2 headline entry back to the current
-buffer with serach option \"::line-number\".
+\"org-remark-link\" of the H2 headline entry back to the current
+buffer with search option \"::line-number\".
 
 ORGID can be passed to this function.  If user option
 `org-remark-use-org-id' is non-nil, this function will add an
@@ -854,7 +854,7 @@ Do you really want to delete the notes?"))
 
 (defun org-remark-notes-buffer-get-or-create ()
   "Return marginal notes buffer.
-It's a cloned indirect buffer of a buffer visiting the margina
+It's a cloned indirect buffer of a buffer visiting the marginal
 notes file of the current buffer.  This function ensures there is
 only one of the marginal notes buffer per session."
   ;; Compare the target marginal notes buffer and current marginal notes 
buffer.
@@ -968,7 +968,7 @@ Each highlight is a list in the following structure:
            highlights))))))
 
 (defun org-remark-highlights-get-positions (&optional reverse)
-  "Return list of the beggining point of all visible highlights in this buffer.
+  "Return list of the beginning point of all visible highlights in this buffer.
 By default, the list is in ascending order.  If REVERSE is
 non-nil, return list in the descending order.
 
@@ -1034,11 +1034,11 @@ the show/hide state."
     (setq org-remark-highlights-hidden nil)))
 
 (defun org-remark-highlights-housekeep ()
-  "Housekeep the internal variable `org-remark-highlights'.
+  "House keep the internal variable `org-remark-highlights'.
 
 Return t.
 
-This is a private function; housekeep is automatically done on
+This is a private function; house keep is automatically done on
 mark, save, and remove -- before sort-highlights.
 
 Case 1. Both start and end of an overlay are identical