Add a docstring to `org-run-like-in-org-mode'

2009-02-26 15:52:45 +01:00 · 2009-02-26 15:52:45 +01:00 · 0a5c3f892d
parent 7455d5aaf8
commit 0a5c3f892d
1 changed files with 4 additions and 0 deletions
--- a/lisp/org.el
+++ b/lisp/org.el
@ -6460,6 +6460,10 @@ Possible values in the list of contexts are `table', `headline', and `item'."

 ;;;###autoload
 (defun org-run-like-in-org-mode (cmd)
+  "Run a command, pretending that the current buffer is in Org-mode.
+This will temporarily bind local variables that are typically bound in
+Org-mode to the values they have in Org-mode, and then interactively
+call CMD."
  (org-load-modules-maybe)
  (unless org-local-vars
    (setq org-local-vars (org-get-local-variables)))