branch: externals/org
commit 506989bed58122bc8994051d8e1c0b8947408c14
Author: TEC <g...@tecosaur.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
ox: Improve #+include parsing docstring
* lisp/ox.el (org-export-parse-include-value): Actually describe the
parsing behaviour of the function in the docstring.
---
lisp/ox.el | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/lisp/ox.el b/lisp/ox.el
index 3ff7799b40..759bd7875d 100644
--- a/lisp/ox.el
+++ b/lisp/ox.el
@@ -3353,7 +3353,21 @@ not have `buffer-file-name' assigned."
footnotes))))))))))))
(defun org-export-parse-include-value (value &optional dir)
- "Extract the various parameters from #+include: VALUE."
+ "Extract the various parameters from #+include: VALUE.
+
+More specifically, this extracts the following parameters to a
+plist: :file, :coding-system, :location, :only-contents, :lines,
+:env, :minlevel, :args, and :block.
+
+The :file parameter is expanded relative to DIR.
+
+The :file, :block, and :args parameters are extracted
+positionally, while the remaining parameters are extracted as
+plist-style keywords.
+
+Any remaining unmatched content is passed through
+`org-babel-parse-header-arguments' (without evaluation) and
+provided as the :unmatched parameter."
(let* ((ind (org-current-text-indentation))
location
(coding-system
