GNU bug report logs - #34274
[PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#34274: closed ([PATCH] * src/callproc.c (call-process/region):
 Fix docstring arg formatting)
Date: Fri, 08 Feb 2019 08:48:02 +0000

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

Your message dated Fri, 08 Feb 2019 10:47:30 +0200
with message-id <834l9er7j1.fsf <at> gnu.org>
and subject line Re: bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting
has caused the debbugs.gnu.org bug report #34274,
regarding [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


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

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

From: Nicholas Drozd <nicholasdrozd <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg
 formatting
Date: Fri, 1 Feb 2019 08:13:10 -0600

---
 src/callproc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/callproc.c b/src/callproc.c
index d4558387cf..f8036f51ef 100644
--- a/src/callproc.c
+++ b/src/callproc.c
@@ -237,7 +237,7 @@ DESTINATION can also have the form (REAL-BUFFER
STDERR-FILE); in that case,
  t (mix it with ordinary output), or a file name string.

 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
-Remaining arguments are strings passed as command arguments to PROGRAM.
+Remaining ARGS are strings passed as command arguments to PROGRAM.

 If executable PROGRAM can't be found as an executable, `call-process'
 signals a Lisp error.  `call-process' reports errors in execution of
@@ -1033,7 +1033,7 @@ STDERR-FILE may be nil (discard standard error output),
 t (mix it with ordinary output), or a file name string.

 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
-Remaining args are passed to PROGRAM at startup as command args.
+Remaining ARGS are passed to PROGRAM at startup as command arguments.

 If BUFFER is 0, `call-process-region' returns immediately with value nil.
 Otherwise it waits for PROGRAM to terminate
-- 
2.17.1

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Nicholas Drozd <nicholasdrozd <at> gmail.com>
Cc: 34274-done <at> debbugs.gnu.org
Subject: Re: bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix
 docstring arg formatting
Date: Fri, 08 Feb 2019 10:47:30 +0200

> From: Nicholas Drozd <nicholasdrozd <at> gmail.com>
> Date: Mon, 4 Feb 2019 17:55:51 -0600
> Cc: 34274 <at> debbugs.gnu.org
> 
> The usual docstring convention is to put arg names in CAPS, making it
> easier to find mentions of the arguments, especially by text search.
> Right now if you search the docstring of call-process for ARGS, you
> won't find anything. There's "remaining arguments", but it's up to the
> reader to figure out that that refers to ARGS. This change just makes
> it easier to navigate.
> 
> In the second case I also changed "command args" to "command
> arguments". This change is unimportant; I just thought it looks nicer.

Thanks, I fixed these doc strings in the spirit of your suggestions.

Previous Next

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