Browse Source

ox-publish: Improve docstrings

* lisp/ox-publish.el (org-publish-cache-get): Improve docstrings.
Nicolas Goaziou 3 years ago
parent
commit
58683d2cf4
1 changed files with 4 additions and 3 deletions
  1. 4 3
      lisp/ox-publish.el

+ 4 - 3
lisp/ox-publish.el

@@ -1270,15 +1270,16 @@ if necessary, unless NO-CREATE is non-nil."
 
 (defun org-publish-cache-get (key)
   "Return the value stored in `org-publish-cache' for key KEY.
-Returns nil, if no value or nil is found, or the cache does not
-exist."
+Return nil, if no value or nil is found.  Raise an error if the
+cache does not exist."
   (unless org-publish-cache
     (error "`org-publish-cache-get' called, but no cache present"))
   (gethash key org-publish-cache))
 
 (defun org-publish-cache-set (key value)
   "Store KEY VALUE pair in `org-publish-cache'.
-Returns value on success, else nil."
+Returns value on success, else nil.  Raise an error if the cache
+does not exist."
   (unless org-publish-cache
     (error "`org-publish-cache-set' called, but no cache present"))
   (puthash key value org-publish-cache))