diff options
author | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2016-11-06 11:30:23 +0100 |
---|---|---|
committer | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2016-11-06 11:30:23 +0100 |
commit | 58683d2cf487a3f275c64eb7cfcee7a344a68d68 (patch) | |
tree | 865822b122c7f65af3275a047216fddf1527e747 | |
parent | dc3c69918f827da9d944834a5509e478a358e40c (diff) | |
download | org-mode-58683d2cf487a3f275c64eb7cfcee7a344a68d68.tar.gz |
ox-publish: Improve docstrings
* lisp/ox-publish.el (org-publish-cache-get): Improve docstrings.
-rw-r--r-- | lisp/ox-publish.el | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/lisp/ox-publish.el b/lisp/ox-publish.el index e64b2e7..2dabcd9 100644 --- a/lisp/ox-publish.el +++ b/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)) |