From 53b595979732841171de59168f0365b7beb7da56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= Date: Wed, 23 Jun 2010 15:22:33 +0200 Subject: [PATCH] Document return value of `make-comint(-in-buffer)'. The return value is important (i.e. not some internal "implementation detail") and existing code depends on it (e.g. `run-scheme' and similar). --- lisp/ChangeLog | 5 +++++ lisp/comint.el | 8 ++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index bbdfa9c..0fda5ac 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,8 @@ +2010-06-23 Štěpán Němec (tiny change) + + * comint.el (make-comint, make-comint-in-buffer): Mention return + value in the docstrings. + 2010-06-22 Glenn Morris * textmodes/texinfmt.el (texinfo-format-region) diff --git a/lisp/comint.el b/lisp/comint.el index b097baa..da354f8 100644 --- a/lisp/comint.el +++ b/lisp/comint.el @@ -701,7 +701,9 @@ (defun make-comint-in-buffer (name buffer program &optional startfile &rest swit STARTFILE is the name of a file, whose contents are sent to the process as its initial input. -If PROGRAM is a string, any more args are arguments to PROGRAM." +If PROGRAM is a string, any more args are arguments to PROGRAM. + +Return the (possibly newly created) process buffer." (or (fboundp 'start-file-process) (error "Multi-processing is not supported for this system")) (setq buffer (get-buffer-create (or buffer (concat "*" name "*")))) @@ -725,7 +727,9 @@ (defun make-comint (name program &optional startfile &rest switches) STARTFILE is the name of a file, whose contents are sent to the process as its initial input. -If PROGRAM is a string, any more args are arguments to PROGRAM." +If PROGRAM is a string, any more args are arguments to PROGRAM. + +Return the (possibly newly created) process buffer." (apply #'make-comint-in-buffer name nil program startfile switches)) ;;;###autoload -- 1.7.1