org-with-remote-undo: Update docstring

* lisp/org-macs.el (org-with-remote-undo): Mention all the arguments.
Document that function is not useful outside agenda.
This commit is contained in:
Ihor Radchenko 2023-08-09 11:47:07 +03:00
parent 8ed3887821
commit 6c40983e86
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 2 additions and 1 deletions

View File

@ -176,7 +176,8 @@ EPOM is an element, point, or marker."
,@body)))))
(defmacro org-with-remote-undo (buffer &rest body)
"Execute BODY while recording undo information in two buffers."
"Execute BODY while recording undo information in current buffer and BUFFER.
This function is only useful when called from org-agenda buffer."
(declare (debug (form body)) (indent 1))
(org-with-gensyms (cline cmd buf1 buf2 undo1 undo2 c1 c2)
`(let ((,cline (org-current-line))