all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Ben Key <bkey76@gmail.com>
To: Emacs Development <Emacs-devel@gnu.org>
Subject: What is wrong with this doc comment
Date: Tue, 7 Jun 2011 23:47:07 -0500	[thread overview]
Message-ID: <BANLkTinBHVwdmLsDaGnuajgSxPA75OG3OQ@mail.gmail.com> (raw)

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.



             reply	other threads:[~2011-06-08  4:47 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-06-08  4:47 Ben Key [this message]
2011-06-08  6:47 ` What is wrong with this doc comment Eli Zaretskii
2011-06-08  8:35 ` Andreas Schwab
2011-06-08 15:48   ` Ben Key

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=BANLkTinBHVwdmLsDaGnuajgSxPA75OG3OQ@mail.gmail.com \
    --to=bkey76@gmail.com \
    --cc=Emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.