From a65fe185e40fce68d7fdb7735b6e7effae31d0ee Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Sun, 27 Jun 2021 17:38:59 +0200 Subject: [PATCH 2/4] ; * lisp/auth-source-pass.el: Improve docstrings --- lisp/auth-source-pass.el | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/lisp/auth-source-pass.el b/lisp/auth-source-pass.el index 6e33970486..0f8be84dc2 100644 --- a/lisp/auth-source-pass.el +++ b/lisp/auth-source-pass.el @@ -60,11 +60,10 @@ auth-source-pass-port-separator (cl-defun auth-source-pass-search (&rest spec &key backend type host user port &allow-other-keys) - "Given a property list SPEC, return search matches from the :backend. -See `auth-source-search' for details on SPEC. + "Given some search query, return matching credentials. -HOST can be a string or a list of strings, but USER and PORT are expected -to be a string only." +See `auth-source-search' for details on the parameters SPEC, BACKEND, TYPE, +HOST, USER and PORT." (cl-assert (or (null type) (eq type (oref backend type))) t "Invalid password-store search: %s %s") (cond ((eq host t) @@ -126,7 +125,7 @@ auth-source-pass-get The key used to retrieve the password is the symbol `secret'. The convention used as the format for a password-store file is -the following (see https://www.passwordstore.org/#organization): +the following (see URL `https://www.passwordstore.org/#organization'): secret key1: value1 @@ -278,7 +277,7 @@ auth-source-pass--entries-matching-suffix (defun auth-source-pass--generate-entry-suffixes (hostname user port) "Return a list of possible entry path suffixes in the password-store. -Based on the supported pathname patterns for HOSTNAME, USER, & +Based on the supported filename patterns for HOSTNAME, USER, & PORT, return a list of possible suffixes for matching entries in the password-store. @@ -326,3 +325,5 @@ auth-source-pass--name-port-user-suffixes (provide 'auth-source-pass) ;;; auth-source-pass.el ends here + +;; LocalWords: backend hostname -- 2.31.1