password-store

commit b830119762416fa8706e479e9b01f2453d6f6ad6
parent e74a1c738f7cda65c7a308e30e8d122f853d6f70
Author: Tino Calancha <tino.calancha@gmail.com>
Date:   Sun, 29 Sep 2019 18:27:29 +0200

emacs: Update docstring of password-store-clear

Clarify that the optional argument is only used in the `message' call.
Bump version to v2.1.3.
* contrib/emacs/password-store.el (password-store-clear): Update docstring.
* contrib/emacs/CHANGELOG.md: Document this change.

Diffstat:
M
contrib/emacs/CHANGELOG.md
 | 
5
+++++
M
contrib/emacs/password-store.el
 | 
11
+++++++++--

2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/contrib/emacs/CHANGELOG.md b/contrib/emacs/CHANGELOG.md
@@ -1,3 +1,8 @@
+# 2.1.3
+
+* Update password-store-clear docstring; clarify that the
+  optional argument is only used in the print out message.
+
 # 2.1.2
 
 * Make argument optional in password-store-clear to preserve
diff --git a/contrib/emacs/password-store.el b/contrib/emacs/password-store.el
@@ -4,7 +4,7 @@
 
 ;; Author: Svend Sorensen <svend@svends.net>
 ;; Maintainer: Tino Calancha <tino.calancha@gmail.com>
-;; Version: 2.1.2
+;; Version: 2.1.3
 ;; URL: https://www.passwordstore.org/
 ;; Package-Requires: ((emacs "25") (f "0.11.0") (s "1.9.0") (with-editor "2.5.11") (auth-source-pass "5.0.0"))
 ;; Keywords: tools pass password password-store
@@ -255,7 +255,14 @@ If FIELD equals to symbol secret, then this function reduces to `password-store-
 
 ;;;###autoload
 (defun password-store-clear (&optional field)
-  "Clear FIELD in kill ring."
+  "Clear secret in the kill ring.
+
+Optional argument FIELD, a symbol or a string, describes
+the stored secret to clear; if nil, then set it to 'secret.
+Note, FIELD does not affect the function logic; it is only used
+to display the message:
+
+\(message \"Field %s cleared.\" field)."
   (interactive "i")
   (unless field (setq field 'secret))
   (when password-store-timeout-timer