bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command

bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command

[Damien Cassou]

[-- Attachment #1: Type: text/plain, Size: 416 bytes --]

* lisp/subr.el (start-process-shell-command): Add recommended
  signature to docstring. This hides the argument ARGS whose use is
  discouraged. This also makes the argument COMMAND visible so the
  user understands what the docstring is referring to.

-- 
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Improve-docstring-of-start-process-shell-command.patch --]
[-- Type: text/x-patch, Size: 1135 bytes --]

From 912261c8dfb337c6f94ca81a495a3690c0628f1e Mon Sep 17 00:00:00 2001
From: Damien Cassou <damien@cassou.me>
Date: Mon, 16 Apr 2018 16:06:36 +0200
Subject: [PATCH] Improve docstring of start-process-shell-command

* lisp/subr.el (start-process-shell-command): Add recommended
  signature to docstring. This hides the argument ARGS whose use is
  discouraged. This also makes the argument COMMAND visible so the
  user understands what the docstring is referring to.
---
 lisp/subr.el | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lisp/subr.el b/lisp/subr.el
index 9cf7d596cd..59bac5a195 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -3107,7 +3107,9 @@ start-process-shell-command
 
 An old calling convention accepted any number of arguments after COMMAND,
 which were just concatenated to COMMAND.  This is still supported but strongly
-discouraged."
+discouraged.
+
+\(fn NAME BUFFER COMMAND)"
   (declare (advertised-calling-convention (name buffer command) "23.1"))
   ;; We used to use `exec' to replace the shell with the command,
   ;; but that failed to handle (...) and semicolon, etc.
-- 
2.14.3

bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command

[Noam Postavsky]

Damien Cassou <damien@cassou.me> writes:

> * lisp/subr.el (start-process-shell-command): Add recommended
>   signature to docstring. This hides the argument ARGS whose use is
>   discouraged. This also makes the argument COMMAND visible so the
>   user understands what the docstring is referring to.

> +\(fn NAME BUFFER COMMAND)"
>    (declare (advertised-calling-convention (name buffer command) "23.1"))

I think this is redundant since advertised-calling-convention already
does the same.

bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command

[Damien Cassou]

Noam Postavsky <npostavs@gmail.com> writes:
>> +\(fn NAME BUFFER COMMAND)"
>>    (declare (advertised-calling-convention (name buffer command) "23.1"))
>
> I think this is redundant since advertised-calling-convention already
> does the same.

you are right, thank you. I didn't know about that and helpful does not
take it into account (I've just reported the issue).

What is the preferred way to advertise a signature, the declare form or
a last line in the docstring? If you answer the question, I can fix the
manual to add links between (info "(elisp) Declare Form") and (info
"(elisp) Function Documentation").

-- 
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command

[Noam Postavsky]

Damien Cassou <damien@cassou.me> writes:

> Noam Postavsky <npostavs@gmail.com> writes:
>>> +\(fn NAME BUFFER COMMAND)"
>>>    (declare (advertised-calling-convention (name buffer command) "23.1"))
>>
>> I think this is redundant since advertised-calling-convention already
>> does the same.
>
> you are right, thank you. I didn't know about that and helpful does not
> take it into account (I've just reported the issue).
>
> What is the preferred way to advertise a signature, the declare form or
> a last line in the docstring? If you answer the question, I can fix the
> manual to add links between (info "(elisp) Declare Form") and (info
> "(elisp) Function Documentation").

The advertised-calling-convention declaration should be used when you
want the old way of calling to trigger a warning during byte
compilation.  Otherwise, the docstring method should be used.

bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command

[Damien Cassou]

On April 17, 2018 3:06:23 PM GMT+02:00, Noam Postavsky <npostavs@gmail.com> wrote:
>Damien Cassou <damien@cassou.me> writes:
>> What is the preferred way to advertise a signature, the declare form
>or
>> a last line in the docstring? If you answer the question, I can fix
>the
>> manual to add links between (info "(elisp) Declare Form") and (info
>> "(elisp) Function Documentation").
>
>The advertised-calling-convention declaration should be used when you
>want the old way of calling to trigger a warning during byte
>compilation.  Otherwise, the docstring method should be used.

Thank you. Can you please close this issue? I will send a patch within another report.
-- 
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command

[Noam Postavsky]

forwarded 31191 https://github.com/Wilfred/helpful/issues/104
close 31191
quit

Damien Cassou <damien@cassou.me> writes:

> Thank you. Can you please close this issue? I will send a patch within another report.

Sure thing.