unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Heime <heimeborgia@protonmail.com>,
	Heime via Users list for the GNU Emacs text editor
	<help-gnu-emacs@gnu.org>
Subject: RE: [External] : Printing function documentation via an interactive option
Date: Thu, 9 May 2024 21:25:21 +0000	[thread overview]
Message-ID: <SJ0PR10MB5488DD8F3A39E1555DAA596DF3E62@SJ0PR10MB5488.namprd10.prod.outlook.com> (raw)
In-Reply-To: <raLdtI4ji_9T8XckILIqeR8EabCrdx3ewd7u0Ecp3YT_ZMsFD3J9NOCnpK3L4NVkzRttYNmDqnYcMoDQMI0A_0FGrVR7e0PkSPNO3xHZzXE=@protonmail.com>

> Would it be possible to display the documentation of the current function
> should a user select the initial value "?".  Furthermore, because I am
> requiring a match, would the initial-value have to be included in
> COLLECTION ?
> 
> 
>   (interactive
>     (list
>       (let ( (cseq '("global-activate" "global-deactivate" "?")) )
>         (completing-read "Switch: " cseq nil t "?"))))

All that does is put `?' in the minibuffer,
with point just after it.

If you just hit RET at that point then the
string "?" is provided as the value of your
function's first argument.

Unless the body of your function interprets
that "?" string as an instruction to invoke
`describe-function' on your function, then
no, just reading that "?" isn't going to
show the help for your function.

  reply	other threads:[~2024-05-09 21:25 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-09 20:56 Printing function documentation via an interactive option Heime
2024-05-09 21:25 ` Drew Adams [this message]
2024-05-09 21:46   ` [External] : " Heime
2024-05-09 22:02     ` Heime
2024-05-09 22:06     ` Drew Adams

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=SJ0PR10MB5488DD8F3A39E1555DAA596DF3E62@SJ0PR10MB5488.namprd10.prod.outlook.com \
    --to=drew.adams@oracle.com \
    --cc=heimeborgia@protonmail.com \
    --cc=help-gnu-emacs@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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).