emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/org f268819d19 1/2: org-babel-common-header-args-w-valu


From: ELPA Syncer
Subject: [elpa] externals/org f268819d19 1/2: org-babel-common-header-args-w-values: Add docstring
Date: Wed, 3 May 2023 13:58:32 -0400 (EDT)

branch: externals/org
commit f268819d19520302e70f7d9b40640e3cc97fa74b
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    org-babel-common-header-args-w-values: Add docstring
    
    * lisp/ob-core.el (org-babel-common-header-args-w-values): Add missing
    docstring.
---
 lisp/ob-core.el | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index b8206bc035..03b63419ac 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -434,7 +434,18 @@ then run `org-babel-switch-to-session'."
     (tangle    . ((tangle yes no :any)))
     (tangle-mode . ((#o755 #o555 #o444 :any)))
     (var       . :any)
-    (wrap       . :any)))
+    (wrap       . :any))
+  "Alist defining common header args and their allowed values.
+Keys of the alist are header arg symbols.  Values of the alist are
+either a symbol `:any' or a list of allowed values.  Each element of
+the value list is either symbol `:any', other symbol representing the
+allowed value, or a list of exclusive values.  `:any' implies that any
+value of the header arg is allowed.  Exclusive values override each
+other when multiple values are used in a given header argument.
+
+A good example of exclusive values is in \"results\" header arg where,
+for example, \"file\" and \"table\" values cannot co-exist.  See info
+node `(org)Results of evaluation' for more details.")
 
 (defconst org-babel-header-arg-names
   (mapcar #'car org-babel-common-header-args-w-values)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]