[nongnu] elpa/base32 32515e59da 052/103: totp-update-token-notification: add docstring

[ELPA Syncer]

branch: elpa/base32
commit 32515e59da82d9de6c6cdd4f641c318187e89f94
Author: Vivek Das Mohapatra <vivek@collabora.co.uk>
Commit: Vivek Das Mohapatra <vivek@collabora.co.uk>

    totp-update-token-notification: add docstring
---
 totp-auth.el | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/totp-auth.el b/totp-auth.el
index ca1b308b39..ab69d89209 100644
--- a/totp-auth.el
+++ b/totp-auth.el
@@ -650,6 +650,11 @@ then wait until it is time to renew the token before doing 
anything."
     (notifications-close-notification id)))
 
 (defun totp-update-token-notification (id label secret)
+  "Update a notification displaying a TOTP token.
+ID is the freedesktop notifications id (an unsigned 32 but integer).
+LABEL is the descriptive label of the OTP secret.
+SECRET is a suitable secret usable by ‘totp-generate-otp’.
+Usually called from a timer set by ‘totp-display-token-notification’."
   (let (otp text ttl)
     (setq otp  (totp-generate-otp secret)
           ttl  (nth 1 otp)