branch: externals/org
commit 21654e9a44f31a0574c626f421b608da834168f3
Author: Ihor Radchenko <yanta...@posteo.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
* lisp/ob-core.el (org-babel-examplify-region): Document all the arguments
---
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 3b3cbbc749..8f46af2d2b 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -2819,7 +2819,10 @@ specified as an an \"attachment:\" style link."
(if description (concat "[" description "]") "")))))
(defun org-babel-examplify-region (beg end &optional results-switches inline)
- "Comment out region using the inline `==' or `: ' org example quote."
+ "Comment out region BEG..END using the inline `==' or `: ' org example quote.
+When INLINE is non-nil, use the inline verbatim markup.
+When INLINE is nil and RESULTS-SWITCHES is non-nil, RESULTS-SWITCHES is
+used as a string to be appended to #+begin_example line."
(interactive "*r")
(let ((maybe-cap
(lambda (str)
