all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting
@ 2019-02-01 14:13 Nicholas Drozd
  2019-02-01 15:14 ` Eli Zaretskii
  0 siblings, 1 reply; 4+ messages in thread
From: Nicholas Drozd @ 2019-02-01 14:13 UTC (permalink / raw)
  To: 34274

---
 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





^ permalink raw reply related	[flat|nested] 4+ messages in thread

* bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting
  2019-02-01 14:13 bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting Nicholas Drozd
@ 2019-02-01 15:14 ` Eli Zaretskii
  2019-02-04 23:55   ` Nicholas Drozd
  0 siblings, 1 reply; 4+ messages in thread
From: Eli Zaretskii @ 2019-02-01 15:14 UTC (permalink / raw)
  To: Nicholas Drozd; +Cc: 34274

> From: Nicholas Drozd <nicholasdrozd@gmail.com>
> 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.

Thanks, but this seems to replace one wording with an equivalent one,
and no rationale was provided as to why.  Could you please provide
your motivation for the changes?





^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting
  2019-02-01 15:14 ` Eli Zaretskii
@ 2019-02-04 23:55   ` Nicholas Drozd
  2019-02-08  8:47     ` Eli Zaretskii
  0 siblings, 1 reply; 4+ messages in thread
From: Nicholas Drozd @ 2019-02-04 23:55 UTC (permalink / raw)
  To: Eli Zaretskii; +Cc: 34274

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.





^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting
  2019-02-04 23:55   ` Nicholas Drozd
@ 2019-02-08  8:47     ` Eli Zaretskii
  0 siblings, 0 replies; 4+ messages in thread
From: Eli Zaretskii @ 2019-02-08  8:47 UTC (permalink / raw)
  To: Nicholas Drozd; +Cc: 34274-done

> From: Nicholas Drozd <nicholasdrozd@gmail.com>
> Date: Mon, 4 Feb 2019 17:55:51 -0600
> Cc: 34274@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.





^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2019-02-08  8:47 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-02-01 14:13 bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting Nicholas Drozd
2019-02-01 15:14 ` Eli Zaretskii
2019-02-04 23:55   ` Nicholas Drozd
2019-02-08  8:47     ` Eli Zaretskii

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.