diff mbox series

[bug#60410,6/7] cache: Specify that cache! returns the cached value.

Message ID 20221229202400.28565-6-arunisaac@systemreboot.net
State New
Headers show
Series mumi: Boolean prefixes in xapian indexing and others | expand

Commit Message

Arun Isaac Dec. 29, 2022, 8:23 p.m. UTC 
* mumi/cache.scm (cache!): Specify in the docstring that cache!
returns the cached value.
---
 mumi/cache.scm | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/mumi/cache.scm b/mumi/cache.scm
index 13b21f9..98a7856 100644
--- a/mumi/cache.scm
+++ b/mumi/cache.scm
@@ -1,5 +1,6 @@ 
 ;;; mumi -- Mediocre, uh, mail interface
 ;;; Copyright © 2020 Ricardo Wurmus <rekado@elephly.net>
+;;; Copyright © 2022 Arun Isaac <arunisaac@systemreboot.net>
 ;;;
 ;;; This program is free software: you can redistribute it and/or
 ;;; modify it under the terms of the GNU Affero General Public License
@@ -34,7 +35,7 @@  expired or return #F."
 (define* (cache! key value
                  #:optional (ttl (%config 'cache-ttl)))
   "Store VALUE for the given KEY and mark it to expire after TTL
-seconds."
+seconds. Return VALUE."
   (let ((t (current-time)))
     (hash-set! %cache key `(#:expires ,(+ t ttl) #:value ,value))
     value))