From de6450aaa43b073007b3c5a2c9d45368a297ec27 Mon Sep 17 00:00:00 2001 From: Adam Porter Date: Sat, 28 Oct 2023 22:29:59 -0500 Subject: [PATCH] Tidy: Docstrings, compilation warnings --- org-web-tools-archive.el | 7 +++++-- org-web-tools.el | 6 +++--- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/org-web-tools-archive.el b/org-web-tools-archive.el index 469c647..7a3dadc 100644 --- a/org-web-tools-archive.el +++ b/org-web-tools-archive.el @@ -236,7 +236,8 @@ on-disk in the temp directory." ;;;; Functions (defun org-web-tools-archive--choose-archive-fn () - "Return archive function selected from `custom-type' values of `org-web-tools-archive-fn'." + "Return archive function. +Selects from `custom-type' values of `org-web-tools-archive-fn'." (let ((choices (cl-loop for choice in (cdr (plist-get (symbol-plist 'org-web-tools-archive-fn) 'custom-type)) for fn = (nth 3 choice) @@ -279,7 +280,9 @@ Return nil if unsuccessful." 'retrying)))))))) (cl-defun org-web-tools-archive--retry (&key id url delay attempts) - "Start and return a timer that calls FN to attach archive of URL to entry with ID after DELAY seconds." + "Start and return a timer for arguments. +Timer calls FN to attach archive of URL to entry with ID after +DELAY seconds." (declare (indent defun)) (let ((fn (lambda () (let ((org-web-tools-attach-url-archive-attempts attempts)) diff --git a/org-web-tools.el b/org-web-tools.el index ba538de..61f66cb 100644 --- a/org-web-tools.el +++ b/org-web-tools.el @@ -128,13 +128,12 @@ Pandoc >= 1.16 deprecates `--no-wrap' in favor of (defcustom org-web-tools-pandoc-replacements (list (cons (rx " ") "")) - "List of alists pairing regular expressions with a string that should replace each one. -Used to clean output from Pandoc." + "Used to clean output from Pandoc." :type '(alist :key-type string :value-type string)) (defcustom org-web-tools-pandoc-sleep-time 0.2 - "When testing Pandoc the first time it's used in a session, wait this long for Pandoc to start. + "Wait this long for Pandoc to start the first time in a session.. Normally this should not need to be changed, but if Pandoc takes unusually long to start on your system (which it seems to on FreeBSD, for some reason), you may need to increase this." @@ -501,6 +500,7 @@ tag)." when (and item (string-match (rx bol "http" (optional "s") "://") item)) return item)) +(declare-function org-element-property "org-element") (defun org-web-tools--read-url () "Return URL at point, or from clipboard, or from kill-ring, or prompt for one." (or (thing-at-point-url-at-point)