Printing function documentation via an interactive option

Printing function documentation via an interactive option

[Heime]

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 "?"))))

RE: [External] : Printing function documentation via an interactive option

[Drew Adams]

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

RE: [External] : Printing function documentation via an interactive option

[Heime]

Sent with Proton Mail secure email.

On Friday, May 10th, 2024 at 9:25 AM, Drew Adams <drew.adams@oracle.com> wrote:

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

Yes, I have a pcase that interprets the "?" as the function argument.
So describe-function can call itself ?

RE: [External] : Printing function documentation via an interactive option

[Heime]

Sent with Proton Mail secure email.

On Friday, May 10th, 2024 at 9:46 AM, Heime <heimeborgia@protonmail.com> wrote:

> Sent with Proton Mail secure email.
> 
> On Friday, May 10th, 2024 at 9:25 AM, Drew Adams drew.adams@oracle.com wrote:
> 
> > > 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.
> 
> Yes, I have a pcase that interprets the "?" as the function argument.
> So describe-function can call itself ?

Have been trying to find the keybindings associated with moving from one item to another
associated with completing-read, but could not find the information. 

RE: [External] : Printing function documentation via an interactive option

[Drew Adams]

> So describe-function can call itself ?

M-x describe-function RET describe-function RET