Subject: bug#41277: [PATCH 5/9] Improve and add doc-strings

From: Jonas Bernoulli <[email-masked]>
Date: Thu, 14 May 2020 21:13:21 +0200

* lisp/epa-file.el (epa-file-select-keys), lisp/epa-hook.el
  (epa-file-name-regexp), lisp/epa.el (epa-exit-buffer): Improve
  doc-string.

* lisp/epa-hook.el (epa-file-name-regexp-update): Add doc-string.
---
 lisp/epa-file.el |  4 ++--
 lisp/epa-hook.el | 11 +++++++----
 lisp/epa.el      |  3 +--
 3 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/lisp/epa-file.el b/lisp/epa-file.el
index 43399d2852..ede7177054 100644
--- a/lisp/epa-file.el
+++ b/lisp/epa-file.el
@@ -43,9 +43,9 @@ epa-file-cache-passphrase-for-symmetric-encryption
 (defcustom epa-file-select-keys nil
   "Control whether or not to pop up the key selection dialog.
 
-If t, always asks user to select recipients.
+If t, always ask user to select recipients.
 If nil, query user only when `epa-file-encrypt-to' is not set.
-If neither t nor nil, doesn't ask user.  In this case, symmetric
+If neither t nor nil, don't ask user.  In this case, symmetric
 encryption is used."
   :type '(choice (const :tag "Ask always" t)
 		 (const :tag "Ask when recipients are not set" nil)
diff --git a/lisp/epa-hook.el b/lisp/epa-hook.el
index 002f46ad27..6f12f8a6bf 100644
--- a/lisp/epa-hook.el
+++ b/lisp/epa-hook.el
@@ -36,10 +36,10 @@ epa-file--file-name-regexp-set
 (defcustom epa-file-name-regexp (purecopy "\\.gpg\\(~\\|\\.~[0-9]+~\\)?\\'")
   "Regexp which matches filenames to be encrypted with GnuPG.
 
-If you set this outside Custom while epa-file is already enabled, you
-have to call `epa-file-name-regexp-update' after setting it to
-properly update file-name-handler-alist.  Setting this through Custom
-does that automatically."
+If you set this outside Custom while epa-file is already enabled,
+you have to call `epa-file-name-regexp-update' after setting it
+to properly update `file-name-handler-alist'.  Setting this
+through Custom does that automatically."
   :type 'regexp
   :group 'epa-file
   :set 'epa-file--file-name-regexp-set)
@@ -73,6 +73,9 @@ epa-file-auto-mode-alist-entry
   (list epa-file-name-regexp nil 'epa-file))
 
 (defun epa-file-name-regexp-update ()
+  "Update `file-name-handler-alist' after configuring outside Custom.
+After setting `epa-file-name-regexp-update' outside the Custom
+interface, update `file-name-handler-alist'."
   (interactive)
   (unless (equal (car epa-file-handler) epa-file-name-regexp)
     (setcar epa-file-handler epa-file-name-regexp)))
diff --git a/lisp/epa.el b/lisp/epa.el
index 62a4941f9d..b06b0ac8e4 100644
--- a/lisp/epa.el
+++ b/lisp/epa.el
@@ -347,8 +347,7 @@ epa-unmark-key
 ;;;; Quitting
 
 (defun epa-exit-buffer ()
-  "Exit the current buffer.
-`epa-exit-buffer-function' is called if it is set."
+  "Exit the current buffer using `epa-exit-buffer-function'."
   (interactive)
   (funcall epa-exit-buffer-function))
 
-- 
2.26.0