branch: externals/org
commit b89bc55867d7cb809c379d371d12d409db785154
Author: Ihor Radchenko <yanta...@posteo.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
org-babel-insert-header-arg: Describe arguments in the docstring
* lisp/ob-core.el (org-babel-insert-header-arg): Fix the docstring,
describing when the arguments do.
---
lisp/ob-core.el | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index c26d236be1..3786845eb9 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -1001,7 +1001,10 @@ arguments and pop open the results in a preview buffer."
;;;###autoload
(defun org-babel-insert-header-arg (&optional header-arg value)
- "Insert a header argument selecting from lists of common args and values."
+ "Insert a header argument and its value.
+HEADER-ARG and VALUE, when provided, are the header argument name and
+its value. When HEADER-ARG or VALUE are nil, offer interactive
+completion from lists of common args and values."
(interactive)
(let* ((info (org-babel-get-src-block-info 'no-eval))
(lang (car info))
