branch: elpa/hyperdrive
commit ab00310b8424466ee92fc395e71fa6e56b60792b
Author: Joseph Turner <jos...@ushin.org>
Commit: Joseph Turner <jos...@ushin.org>
Fix: Describe return values in docstrings
---
hyperdrive-lib.el | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/hyperdrive-lib.el b/hyperdrive-lib.el
index 6f81c722d2..211e8f1cb0 100644
--- a/hyperdrive-lib.el
+++ b/hyperdrive-lib.el
@@ -396,9 +396,10 @@ When VERSION is nil, return latest version of ENTRY."
(cl-defun hyperdrive-open (entry &key then recurse (createp t))
"Open hyperdrive ENTRY.
If RECURSE, proceed up the directory hierarchy if given path is
-not found. THEN may be a function to pass to the handler to call
-in the buffer opened by the handler. When a writable ENTRY is not
-found and CREATEP is non-nil, create a new buffer for ENTRY."
+not found. THEN is a function to pass to the handler which will
+be called with no arguments in the buffer opened by the handler.
+When a writable ENTRY is not found and CREATEP is non-nil, create
+a new buffer for ENTRY."
(declare (indent defun))
;; TODO: Add `find-file'-like interface. See
<https://todo.sr.ht/~ushin/ushin/16>
;; TODO: When possible, check whether drive is writable with a HEAD request,
and set writablep in the
@@ -531,7 +532,9 @@ The following ENTRY slots are filled:
The following ENTRY hyperdrive slots are filled:
- public-key
-- domains (merged with current persisted value)"
+- domains (merged with current persisted value)
+
+Returns filled ENTRY."
(pcase-let* (((cl-struct hyperdrive-entry hyperdrive) entry)
((map link content-length content-type etag last-modified)
headers)
;; If URL hostname was a DNSLink domain, entry doesn't yet have
a public-key slot.
