GNU bug report logs - #6498
24.0.50; [PATCH] Document return value of `make-comint(-in-buffer)'

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Štěpán Němec
 <stepnem <at> gmail.com>
Subject: bug#6498: closed (Re: bug#6498: 24.0.50; [PATCH] Document return
 value of `make-comint(-in-buffer)')
Date: Thu, 24 Jun 2010 06:45:03 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#6498: 24.0.50; [PATCH] Document return value of `make-comint(-in-buffer)'

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 6498 <at> debbugs.gnu.org.

-- 
6498: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=6498
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Glenn Morris <rgm <at> gnu.org>
To: 6498-done <at> debbugs.gnu.org
Subject: Re: bug#6498: 24.0.50;
	[PATCH] Document return value of `make-comint(-in-buffer)'
Date: Thu, 24 Jun 2010 02:44:06 -0400

Thanks; applied.

Note that typically only the first sentence (and possibly first
paragraph) of a doc string use the imperative, so I changed that
aspect. See "Documentation Tips" in the Elisp manual.

You have several tiny changes in Emacs now, and they do add up.
We should really get a copyright assignment or disclaimer before
installing any more. The process is straightforward and starts with a
simple form to fill out. May I email it to you?

[Message part 3 (message/rfc822, inline)]

From: Štěpán Němec <stepnem <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.0.50; [PATCH] Document return value of `make-comint(-in-buffer)'
Date: Wed, 23 Jun 2010 15:32:58 +0200

[Message part 4 (text/plain, inline)]

Tags: patch


Return value of these functions is important and should be documented.

Patch attached.


    Štěpán

[0001-Document-return-value-of-make-comint-in-buffer.patch (text/x-diff, inline)]

From 53b595979732841171de59168f0365b7beb7da56 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= <stepnem <at> gmail.com>
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  <stepnem <at> gmail.com>  (tiny change)
+
+	* comint.el (make-comint, make-comint-in-buffer): Mention return
+	value in the docstrings.
+
 2010-06-22  Glenn Morris  <rgm <at> gnu.org>
 
 	* 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

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.