Printing documentation string of another function

Printing documentation string of another function

[Heime]

Is it possible to have a function that prints the documentation string 
of another function ?

Re: Printing documentation string of another function

[Zhengyi Fu]

> 在 2024年4月10日，下午8:49，Heime <heimeborgia@protonmail.com> 写道：
> 
> Is it possible to have a function that prints the documentation string
> of another function ?
> 
https://www.gnu.org/software/emacs/manual/html_node/elisp/Accessing-Documentation.html 
I recommend you read the manual before asking here.
> 

Re: Printing documentation string of another function

[Heime]

On Thursday, April 11th, 2024 at 12:55 AM, Zhengyi Fu <i@fuzy.me> wrote:

> > 在 2024年4月10日，下午8:49，Heime heimeborgia@protonmail.com 写道：
> > 
> > Is it possible to have a function that prints the documentation string
> > of another function ?
> 
> https://www.gnu.org/software/emacs/manual/html_node/elisp/Accessing-Documentation.html
> I recommend you read the manual before asking here.

It is not very clear. Would that be 

documentation function &optional verbatim

Re: Printing documentation string of another function

[Joost Kremers]

On Wed, Apr 10 2024, Zhengyi Fu wrote:
>> 在 2024年4月10日，下午8:49，Heime <heimeborgia@protonmail.com> 写道：
>> 
>> Is it possible to have a function that prints the documentation string
>> of another function ?
>> 
> https://www.gnu.org/software/emacs/manual/html_node/elisp/Accessing-Documentation.html
> I recommend you read the manual before asking here.

I would also recommend using Emacs' own documentation system. `C-h i` starts the
info system. Press `h` for an introduction on using it.

-- 
Joost Kremers
Life has its moments

Re: Printing documentation string of another function

[Heime]

Sent with Proton Mail secure email.

On Thursday, April 11th, 2024 at 1:22 AM, Joost Kremers <joostkremers@fastmail.fm> wrote:

> On Wed, Apr 10 2024, Zhengyi Fu wrote:
> 
> > > 在 2024年4月10日，下午8:49，Heime heimeborgia@protonmail.com 写道：
> > > 
> > > Is it possible to have a function that prints the documentation string
> > > of another function ?
> > 
> > https://www.gnu.org/software/emacs/manual/html_node/elisp/Accessing-Documentation.html
> > I recommend you read the manual before asking here.
> 
> 
> I would also recommend using Emacs' own documentation system. `C-h i` starts the
> info system. Press `h` for an introduction on using it.
> 
> --
> Joost Kremers
> Life has its moments

With the following implementation, I cannot get the documentation string 
of the appropriate function to display.

(defun avus-doc (seltr)
  "Print the documentation string of a particular function."

  (interactive
    (list
      (let ( (cseq '("Greek"   "Flokki")) )
        (completing-read "Doc: " cseq nil t "Greek"))))

  (pcase seltr
    ("Greek"     (documentation 'avus-greek))
    ("Flokki"    (documentation 'avus-flokki))) )

Re: Printing documentation string of another function

[Stephen Berman]

On Wed, 10 Apr 2024 17:17:00 +0000 Heime <heimeborgia@protonmail.com> wrote:

> With the following implementation, I cannot get the documentation string
> of the appropriate function to display.
>
> (defun avus-doc (seltr)
>   "Print the documentation string of a particular function."
>
>   (interactive
>     (list
>       (let ( (cseq '("Greek"   "Flokki")) )
>         (completing-read "Doc: " cseq nil t "Greek"))))
>
>   (pcase seltr
>     ("Greek"     (documentation 'avus-greek))
>     ("Flokki"    (documentation 'avus-flokki))) )

`(documentation 'avus-greek)' just returns the doc string, it does not
display it.  You have to add code to do that, e.g.:

(defun avus-doc (seltr)
  "Print the documentation string of a particular function."
  (interactive
   (list
    (let ((cseq '("Greek" "Flokki")))
      (completing-read "Doc: " cseq nil t "Greek"))))
  (let ((doc (pcase seltr
	       ("Greek"     (documentation 'avus-greek))
	       ("Flokki"    (documentation 'avus-flokki)))))
    (tooltip-show doc)))

Steve Berman

Re: Printing documentation string of another function

[Heime]

On Thursday, April 11th, 2024 at 7:36 AM, Stephen Berman <stephen.berman@gmx.net> wrote:

> On Wed, 10 Apr 2024 17:17:00 +0000 Heime heimeborgia@protonmail.com wrote:
> 
> > With the following implementation, I cannot get the documentation string
> > of the appropriate function to display.
> > 
> > (defun avus-doc (seltr)
> > "Print the documentation string of a particular function."
> > 
> > (interactive
> > (list
> > (let ( (cseq '("Greek" "Flokki")) )
> > (completing-read "Doc: " cseq nil t "Greek"))))
> > 
> > (pcase seltr
> > ("Greek" (documentation 'avus-greek))
> > ("Flokki" (documentation 'avus-flokki))) )
> 
> 
> `(documentation 'avus-greek)' just returns the doc string, it does not
> display it. You have to add code to do that, e.g.:
> 
> (defun avus-doc (seltr)
> "Print the documentation string of a particular function."
> (interactive
> (list
> (let ((cseq '("Greek" "Flokki")))
> (completing-read "Doc: " cseq nil t "Greek"))))
> (let ((doc (pcase seltr
> ("Greek" (documentation 'avus-greek))
> ("Flokki" (documentation 'avus-flokki)))))
> (tooltip-show doc)))
> 
> Steve Berman

I want to print in the usual documentation buffer as doing 
C-h f avus-greek or C-h f avus-flokki

Re: Printing documentation string of another function

[Stephen Berman]

On Wed, 10 Apr 2024 20:09:44 +0000 Heime <heimeborgia@protonmail.com> wrote:

> On Thursday, April 11th, 2024 at 7:36 AM, Stephen Berman
> <stephen.berman@gmx.net> wrote:
>
>> On Wed, 10 Apr 2024 17:17:00 +0000 Heime heimeborgia@protonmail.com wrote:
>>
>> > With the following implementation, I cannot get the documentation string
>> > of the appropriate function to display.
>> >
>> > (defun avus-doc (seltr)
>> > "Print the documentation string of a particular function."
>> >
>> > (interactive
>> > (list
>> > (let ( (cseq '("Greek" "Flokki")) )
>> > (completing-read "Doc: " cseq nil t "Greek"))))
>> >
>> > (pcase seltr
>> > ("Greek" (documentation 'avus-greek))
>> > ("Flokki" (documentation 'avus-flokki))) )
>>
>>
>> `(documentation 'avus-greek)' just returns the doc string, it does not
>> display it. You have to add code to do that, e.g.:
>>
>> (defun avus-doc (seltr)
>> "Print the documentation string of a particular function."
>> (interactive
>> (list
>> (let ((cseq '("Greek" "Flokki")))
>> (completing-read "Doc: " cseq nil t "Greek"))))
>> (let ((doc (pcase seltr
>> ("Greek" (documentation 'avus-greek))
>> ("Flokki" (documentation 'avus-flokki)))))
>> (tooltip-show doc)))
>>
>> Steve Berman
>
> I want to print in the usual documentation buffer as doing
> C-h f avus-greek or C-h f avus-flokki

(defun avus-doc (seltr)
  "Print the documentation string of a particular function."
  (interactive
   (list
    (let ((cseq '("Greek" "Flokki")))
      (completing-read "Doc: " cseq nil t "Greek"))))
  (describe-function (pcase seltr
		       ("Greek" 'avus-greek)
		       ("Flokki" 'avus-flokki))))

Steve Berman

RE: [External] : Re: Printing documentation string of another function

[Drew Adams]

> > I want to print in the usual documentation buffer as doing
> > C-h f avus-greek or C-h f avus-flokki
> 
> (defun avus-doc (seltr)
...
>   (describe-function (pcase seltr
> 	 ("Greek" 'avus-greek)
> 	 ("Flokki" 'avus-flokki))))

Which OP could likely have figured out
from doing `C-h k C-h f'.

Learn to fish - ask Emacs, she wants
to help.

RE: [External] : Re: Printing documentation string of another function

[Heime]

On Thursday, April 11th, 2024 at 11:14 AM, Drew Adams <drew.adams@oracle.com> wrote:

> > > I want to print in the usual documentation buffer as doing
> > > C-h f avus-greek or C-h f avus-flokki
> > 
> > (defun avus-doc (seltr)
> 
> ...
> 
> > (describe-function (pcase seltr
> > ("Greek" 'avus-greek)
> > ("Flokki" 'avus-flokki))))
> 
> 
> Which OP could likely have figured out
> from doing `C-h k C-h f'.
> 
> Learn to fish - ask Emacs, she wants
> to help.

Yes, I figured it was calling describe-function.