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.
This commit is contained in:
Ihor Radchenko 2023-08-14 14:59:11 +03:00
parent 34ee6f1a21
commit b89bc55867
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 4 additions and 1 deletions

View File

@ -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))