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

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

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

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



Reply | Threaded
Open this post in threaded view
|

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

Eli Zaretskii
> From: Nicholas Drozd <[hidden email]>
> 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?



Reply | Threaded
Open this post in threaded view
|

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

Nicholas Drozd
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.



Reply | Threaded
Open this post in threaded view
|

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

Eli Zaretskii
> From: Nicholas Drozd <[hidden email]>
> Date: Mon, 4 Feb 2019 17:55:51 -0600
> Cc: [hidden email]
>
> 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.