What is wrong with this doc comment

What is wrong with this doc comment

[Ben Key]

Hello,

The following is the doc comment I am using for my new
ns-keychain-create-item function.  It does not yield the expected
results.

doc: /* Create a new item in KEYCHAIN with label ITEM and password PASSWORD.
The remaining arguments are optional.  They specify attributes for the keychain
item in the form of key-value pairs.  The keys are keyword symbols, starting
with a colon.

Example:
  \(secrets-create-item \"Tramp collection\" \"item\" \"geheim\"
   :method \"sudo\" :user \"joe\" :host \"remote-host\"\)

The object path of the created item is returned. */

The resulting help message is as follows.

ns-keychain-create-item is a built-in function in `C source code'.

(ns-keychain-create-item ARG1 ARG2 ARG3 &rest REST)

Create a new item in KEYCHAIN with label ITEM and password PASSWORD.
The remaining arguments are optional.  They specify attributes for the keychain
item in the form of key-value pairs.  The keys are keyword symbols, starting
with a colon.

Example:
  (secrets-create-item "Tramp collection" "item" "geheim"
   :method "sudo" :user "joe" :host "remote-host")

The object path of the created item is returned.


Why does the help message have ARG1 ARG2 ARG3 &rest REST instead of
KEYCHAIN ITEM PASSWORD?

Thanks.

Re: What is wrong with this doc comment

[Eli Zaretskii]

> From: Ben Key <bkey76@gmail.com>
> Date: Tue, 7 Jun 2011 23:47:07 -0500
> 
> Why does the help message have ARG1 ARG2 ARG3 &rest REST instead of
> KEYCHAIN ITEM PASSWORD?

The doc string alone is not enough to answer that.  Please show the
beginning of your DEFUN form, up to and including the argument list.

Re: What is wrong with this doc comment

[Andreas Schwab]

Ben Key <bkey76@gmail.com> writes:

> Why does the help message have ARG1 ARG2 ARG3 &rest REST instead of
> KEYCHAIN ITEM PASSWORD?

Because you didn't declare the names.  See widget-apply for an example.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: What is wrong with this doc comment

[Ben Key]

On Wed, Jun 8, 2011 at 3:35 AM, Andreas Schwab <schwab@linux-m68k.org> wrote:
> Because you didn't declare the names.  See widget-apply for an example.

Thanks.  You gave me the clue I needed to figure it out.  I needed to
add something like the following to my doc comment.

usage: (ns-keychain-create-item COLLECTION ITEM PASSWORD &rest ATTRIBUTES)