From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 18 May 2023 11:03:10 +0000 (+0300)
Subject: ; * lisp/simple.el (async-shell-command): Add commentary about 3rd arg.
X-Git-Tag: emacs-29.0.92~135
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=4daa6f70497f90fa2640ab9d10b29ad2ace1991b;p=emacs.git

; * lisp/simple.el (async-shell-command): Add commentary about 3rd arg.
---

diff --git a/lisp/simple.el b/lisp/simple.el
index 0138556787b..3f88fcb8d03 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -4454,6 +4454,10 @@ whose `car' is BUFFER."
                           '(nil (inhibit-switch-frame . t)))))
                 (set-window-point win pos)))))))))
 
+;; Implementation note: the next function intentionally tries to use
+;; the same signature as 'shell-command', although the 3rd arg is
+;; currently ignored, to allow us to implement support for specifying
+;; ERROR-BUFFER in the future.
 (defun async-shell-command (command &optional output-buffer error-buffer)
   "Execute string COMMAND asynchronously in background.