ox: Clarify a docstring

* lisp/ox.el (org-export-get-all-options): Specify return value for
  unknown back-ends.
(org-export--parse-option-keyword):
(org-export--get-subtree-options):
(org-export--get-inbuffer-options):
(org-export--get-global-options): Remove useless check.
This commit is contained in:
Nicolas Goaziou 2017-03-23 16:38:59 +01:00
parent 4b4ccdc3fa
commit aadde88799
1 changed files with 7 additions and 5 deletions

View File

@ -1069,7 +1069,9 @@ BACKEND is an export back-end, as return by, e.g,,
for the shape of the return value.
Unlike to `org-export-backend-options', this function also
returns options inherited from parent back-ends, if any."
returns options inherited from parent back-ends, if any.
Return nil if BACKEND is unknown."
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
(when backend
(let ((options (org-export-backend-options backend))
@ -1373,7 +1375,7 @@ specific items to read, if any."
alist))
alist))
;; Priority is given to back-end specific options.
(all (append (and backend (org-export-get-all-options backend))
(all (append (org-export-get-all-options backend)
org-export-options-alist))
(plist))
(when line
@ -1410,7 +1412,7 @@ for export. Return options as a plist."
(match-string-no-properties 4))))))
;; Look for both general keywords and back-end specific
;; options, with priority given to the latter.
(options (append (and backend (org-export-get-all-options backend))
(options (append (org-export-get-all-options backend)
org-export-options-alist)))
;; Handle other keywords. Then return PLIST.
(dolist (option options plist)
@ -1446,7 +1448,7 @@ Assume buffer is in Org mode. Narrowing, if any, is ignored."
(let* ((case-fold-search t)
(options (append
;; Priority is given to back-end specific options.
(and backend (org-export-get-all-options backend))
(org-export-get-all-options backend)
org-export-options-alist))
(regexp (format "^[ \t]*#\\+%s:"
(regexp-opt (nconc (delq nil (mapcar #'cadr options))
@ -1583,7 +1585,7 @@ which back-end specific export options should also be read in the
process."
(let (plist
;; Priority is given to back-end specific options.
(all (append (and backend (org-export-get-all-options backend))
(all (append (org-export-get-all-options backend)
org-export-options-alist)))
(dolist (cell all plist)
(let ((prop (car cell)))