Merge pull request #387 from jmay/master

bastibe · web-flow · commit 839a2e19865a · 2022-04-08T08:29:35.000+02:00
fill docstrings to prevent byte-compile warnings
diff --git a/org-journal.el b/org-journal.el
@@ -453,9 +453,11 @@ This runs once per date, before `org-journal-after-entry-create-hook'.")
 (global-set-key (kbd "C-c C-j") 'org-journal-new-entry)
 
 (defmacro org-journal--with-journal (file &rest body)
-  "Opens JOURNAL-FILE in fundamental mode, or switches to the buffer which is visiting JOURNAL-FILE.
+  "Opens JOURNAL-FILE in fundamental mode, or switches to the
+buffer which is visiting JOURNAL-FILE.
 
-Returns the last value from BODY. If the buffer didn't exist before it will be deposed."
+Returns the last value from BODY. If the buffer didn't exist
+before it will be deposed."
   ;; Use find-file... instead of view-file... since
   ;; view-file does not respect auto-mode-alist
   (declare (indent 1))
@@ -528,7 +530,8 @@ Returns the last value from BODY. If the buffer didn't exist before it will be d
 
 ;;;###autoload
 (defun org-journal-convert-created-property-timestamps (old-format)
-  "Convert CREATED property timestamps to `org-journal-created-property-timestamp-format'."
+  "Convert format of CREATED property timestamps.
+Convert OLD-FORMAT or input to `org-journal-created-property-timestamp-format'."
   (interactive "sEnter old format: ")
   (if (org-journal--daily-p)
       (message "Nothing to do, org-journal-file-type is 'daily")
@@ -568,21 +571,21 @@ the first date of the year."
     ;; Round to the monday of the current week, e.g. 20181231 is the first week of 2019
     (`weekly
      (let* ((absolute-monday
-	     (calendar-iso-to-absolute
-	      (mapcar 'string-to-number
-		      (split-string (format-time-string "%V 1 %G" time) " "))))
-	    (absolute-now
-	     (calendar-absolute-from-gregorian
-	      (mapcar 'string-to-number
-		      (split-string (format-time-string "%m %d %Y" time) " "))))
-	    (target-date
-	     (+ absolute-monday
-		(- org-journal-start-on-weekday 1)))
-	    (date
+             (calendar-iso-to-absolute
+              (mapcar 'string-to-number
+                      (split-string (format-time-string "%V 1 %G" time) " "))))
+            (absolute-now
+             (calendar-absolute-from-gregorian
+              (mapcar 'string-to-number
+                      (split-string (format-time-string "%m %d %Y" time) " "))))
+            (target-date
+             (+ absolute-monday
+                (- org-journal-start-on-weekday 1)))
+            (date
              (calendar-gregorian-from-absolute
               (if (> target-date absolute-now)
-		  (- target-date 7)
-		target-date))))
+                  (- target-date 7)
+                target-date))))
        (org-journal--calendar-date->time date)))
     ;; Round to the first day of the month, e.g. 20190301
     (`monthly
@@ -594,7 +597,8 @@ the first date of the year."
       (mapcar 'string-to-number (split-string (format-time-string "1 1 %Y" time) " "))))))
 
 (defun org-journal--get-entry-path (&optional time)
-  "Return the path to an entry matching TIME, if no TIME is given, uses the current time."
+  "Return the path to an entry matching TIME.
+If no TIME is given, uses the current time."
   (let ((file (file-truename
                (expand-file-name
                 (format-time-string org-journal-file-format
@@ -747,12 +751,12 @@ This allows the use of `org-journal-tag-alist' and
 (defun org-journal-new-entry (prefix &optional time)
   "Open today's journal file and start a new entry.
 
-With a PREFIX arg, open the today's file, create a heading if it doesn't exist yet,
-but do not create a new entry.
+With a PREFIX arg, open the today's file, create a heading if it
+doesn't exist yet, but do not create a new entry.
 
-If given a TIME, create an entry for the time's day. If no TIME was given,
-use the current time (which is interpreted as belonging to yesterday if
-smaller than `org-extend-today-until').
+If given a TIME, create an entry for the time's day. If no TIME
+was given, use the current time (which is interpreted as
+belonging to yesterday if smaller than `org-extend-today-until').
 
 Whenever a journal entry is created the `org-journal-after-entry-create-hook'
 hook is run."
@@ -1073,11 +1077,12 @@ This is the counterpart of `org-journal--file-name->calendar-date' for
 (defun org-journal-new-date-entry (prefix &optional event)
   "Open the journal for the date indicated by point and start a new entry.
 
-If the date is not today, it won't be given a time heading. With one prefix (C-u),
-don't add a new heading.
+If the date is not today, it won't be given a time heading. With
+one prefix (C-u), don't add a new heading.
 
-If the date is in the future, create a schedule entry, unless two universal prefix
-arguments (C-u C-u) are given. In that case insert just the heading."
+If the date is in the future, create a schedule entry, unless two
+universal prefix arguments (C-u C-u) are given. In that case
+insert just the heading."
   (interactive
    (list current-prefix-arg last-nonmenu-event))
   (let* ((time (or (ignore-errors (org-journal--calendar-date->time (calendar-cursor-to-date t event)))
@@ -1540,8 +1545,8 @@ existed before)."
 (def-edebug-spec org-journal--with-find-file (form body))
 
 (defun org-journal--update-org-agenda-files ()
-  "Adds the current and future journal files to `org-agenda-files' containing TODOs,
-and cleans out past org-journal files."
+  "Adds the current and future journal files to `org-agenda-files'
+containing TODOs, and cleans out past org-journal files."
   (when org-journal-enable-agenda-integration
     (let ((not-org-journal-agenda-files
            (seq-filter
@@ -1560,7 +1565,7 @@ and cleans out past org-journal files."
               (org-journal--calendar-date->time beg)
               (org-journal--calendar-date->time end)))))
       (org-store-new-agenda-file-list (append not-org-journal-agenda-files
-					      org-journal-agenda-files)))))
+                                              org-journal-agenda-files)))))
 
 (defvar org-journal--schedule-buffer-name "*Org-journal schedule*")
 
@@ -1859,7 +1864,7 @@ If STR is empty, search for all entries using `org-journal-time-prefix'."
 (defun org-journal-re-encrypt-journals (recipient)
   "Re-encrypt journal files."
   (interactive (list (epa-select-keys (epg-make-context epa-protocol)
-			              "Select new recipient for encryption.
+                                      "Select new recipient for encryption.
 Only one recipient is supported.  ")))
 
   (unless recipient
@@ -1869,29 +1874,29 @@ Only one recipient is supported.  ")))
     (user-error "org-journal encryption not enabled"))
 
   (cl-loop
-    with buf
-    with kill-buffer
-    for journal in (org-journal--list-files)
-    do
-      (setq buf (find-buffer-visiting journal)
-            kill-buffer nil)
-
-      (when (and buf
-                 (buffer-modified-p buf)
-                 (y-or-n-p (format "Journal \"%s\" modified, save before re-encryption?"
-                                   (file-name-nondirectory journal))))
-        (save-buffer buf))
-
-      (unless buf
-        (setq kill-buffer t
-              buf (find-file-noselect journal)))
-
-      (with-current-buffer buf
-        (let ((epa-file-encrypt-to (epg-sub-key-id (car (epg-key-sub-key-list (car recipient))))))
-          (set-buffer-modified-p t)
-          (save-buffer)
-          (when kill-buffer
-            (kill-buffer))))))
+   with buf
+   with kill-buffer
+   for journal in (org-journal--list-files)
+   do
+   (setq buf (find-buffer-visiting journal)
+         kill-buffer nil)
+
+   (when (and buf
+              (buffer-modified-p buf)
+              (y-or-n-p (format "Journal \"%s\" modified, save before re-encryption?"
+                                (file-name-nondirectory journal))))
+     (save-buffer buf))
+
+   (unless buf
+     (setq kill-buffer t
+           buf (find-file-noselect journal)))
+
+   (with-current-buffer buf
+     (let ((epa-file-encrypt-to (epg-sub-key-id (car (epg-key-sub-key-list (car recipient))))))
+       (set-buffer-modified-p t)
+       (save-buffer)
+       (when kill-buffer
+         (kill-buffer))))))
 
 (defun org-journal--decrypt ()
   "Decrypt journal entry at point."
@@ -1908,7 +1913,8 @@ Only one recipient is supported.  ")))
       (save-buffer))))
 
 (defun org-journal-default-enable-encryption ()
-  "Add org-journal-encryption-hook to the hook org-journal-encrypt-on, enabling encryption by default."
+  "Add org-journal-encryption-hook to the hook org-journal-encrypt-on,
+enabling encryption by default."
   (add-hook org-journal-encrypt-on
             'org-journal-encryption-hook
             nil t))
