Interactive function

Interactive function

[uzibalqa]

I have the following function that prints some information about Emacs Init.
The messages for the user are included in the function documentation part.
Thusly, I would like that when the user calls "M-x emacs-init", I show the
docstring.  How can I implement such feature in the body of the function to
call the docstring? 


(defun emacs-init ()

  "TODO.

Emacs packages write their caches, histories, etc. into ~/.emacs.d/.

See directory '.emacs.d' in directory

${HOME}/xepty/"

  (interactive)

  (message "See C-h f emacs-init") )

Re: Interactive function

[thibaut.verron]

Something like that?

(defun function (args)
  "Docstring"
  (describe-function #'function))

You should probably not show this to the compiler though.


On 10/10/2022 15:24, uzibalqa <uzibalqa@proton.me> wrote:
> I have the following function that prints some information about Emacs Init.
> The messages for the user are included in the function documentation part.
> Thusly, I would like that when the user calls "M-x emacs-init", I show the
> docstring.  How can I implement such feature in the body of the function to
> call the docstring?
> 
> 
> (defun emacs-init ()
> 
>    "TODO.
> 
> Emacs packages write their caches, histories, etc. into ~/.emacs.d/.
> 
> See directory '.emacs.d' in directory
> 
> ${HOME}/xepty/"
> 
>    (interactive)
> 
>    (message "See C-h f emacs-init") )
> 
> 
> 
> 
> 
> 

Re: Interactive function

[uzibalqa]

------- Original Message -------
On Monday, October 10th, 2022 at 1:43 PM, <thibaut.verron@gmail.com> wrote:


> Something like that?
> 
> (defun function (args)
> "Docstring"
> (describe-function #'function))
> 
> You should probably not show this to the compiler though.

I do not understand the "not show to the compiler" part.
 
 
> On 10/10/2022 15:24, uzibalqa uzibalqa@proton.me wrote:
> 
> > I have the following function that prints some information about Emacs Init.
> > The messages for the user are included in the function documentation part.
> > Thusly, I would like that when the user calls "M-x emacs-init", I show the
> > docstring. How can I implement such feature in the body of the function to
> > call the docstring?
> > 
> > (defun emacs-init ()
> > 
> > "TODO.
> > 
> > Emacs packages write their caches, histories, etc. into ~/.emacs.d/.
> > 
> > See directory '.emacs.d' in directory
> > 
> > ${HOME}/xepty/"
> > 
> > (interactive)
> > 
> > (message "See C-h f emacs-init") )

Re: Interactive function

[Thibaut Verron]

On 10/10/2022 16:23, uzibalqa wrote:
> ------- Original Message -------
> On Monday, October 10th, 2022 at 1:43 PM, <thibaut.verron@gmail.com> wrote:
>
>
>> Something like that?
>>
>> (defun function (args)
>> "Docstring"
>> (describe-function #'function))
>>
>> You should probably not show this to the compiler though.
> I do not understand the "not show to the compiler" part.

I was thinking that the compiler might take offense at the use of the 
function before it is properly defined. But on second thought, it 
shouldn't really be different from resolving a recursive call.


>   
>   
>> On 10/10/2022 15:24, uzibalqa uzibalqa@proton.me wrote:
>>
>>> I have the following function that prints some information about Emacs Init.
>>> The messages for the user are included in the function documentation part.
>>> Thusly, I would like that when the user calls "M-x emacs-init", I show the
>>> docstring. How can I implement such feature in the body of the function to
>>> call the docstring?
>>>
>>> (defun emacs-init ()
>>>
>>> "TODO.
>>>
>>> Emacs packages write their caches, histories, etc. into ~/.emacs.d/.
>>>
>>> See directory '.emacs.d' in directory
>>>
>>> ${HOME}/xepty/"
>>>
>>> (interactive)
>>>
>>> (message "See C-h f emacs-init") )

Re: Interactive function

[uzibalqa]

------- Original Message -------
On Monday, October 10th, 2022 at 2:46 PM, Thibaut Verron <thibaut.verron@gmail.com> wrote:


> On 10/10/2022 16:23, uzibalqa wrote:
> 
> > ------- Original Message -------
> > On Monday, October 10th, 2022 at 1:43 PM, thibaut.verron@gmail.com wrote:
> > 
> > > Something like that?
> > > 
> > > (defun function (args)
> > > "Docstring"
> > > (describe-function #'function))
> > > 
> > > You should probably not show this to the compiler though.
> > > I do not understand the "not show to the compiler" part.
> 
> 
> I was thinking that the compiler might take offense at the use of the
> function before it is properly defined. But on second thought, it
> shouldn't really be different from resolving a recursive call.

Seems to be working well when I use it.
 
> > > On 10/10/2022 15:24, uzibalqa uzibalqa@proton.me wrote:
> > > 
> > > > I have the following function that prints some information about Emacs Init.
> > > > The messages for the user are included in the function documentation part.
> > > > Thusly, I would like that when the user calls "M-x emacs-init", I show the
> > > > docstring. How can I implement such feature in the body of the function to
> > > > call the docstring?
> > > > 
> > > > (defun emacs-init ()
> > > > 
> > > > "TODO.
> > > > 
> > > > Emacs packages write their caches, histories, etc. into ~/.emacs.d/.
> > > > 
> > > > See directory '.emacs.d' in directory
> > > > 
> > > > ${HOME}/xepty/"
> > > > 
> > > > (interactive)
> > > > 
> > > > (message "See C-h f emacs-init") )

Re: Interactive function

[Emanuel Berg]

thibaut.verron wrote:

> (defun function (args)

Uhm, you are aware `function' is already a function ..

> #'function

Interesting, and it would seem so BTW :^)

-- 
underground experts united
https://dataswamp.org/~incal

Re: Interactive function

[Emanuel Berg]

Thibaut Verron wrote:

> I was thinking that the compiler might take offense at the
> use of the function before it is properly defined.

Before evaluating your function, do

  (describe-function #'function)

But it seems you cannot do

  (describe-function #'#')

However

  (describe-function (function function))

is fine :)

> But on second thought, it shouldn't really be different from
> resolving a recursive call.

Yes:

(defun describe-me ()
  (describe-function #'describe-me) )

(defun recurse-you (n)
  (if (not (zerop n))
    (+ n (recurse-you (1- n)))
    n) )

-- 
underground experts united
https://dataswamp.org/~incal

Re: Interactive function

[Michael Heerdegen]

Emanuel Berg <incal@dataswamp.org> writes:

> But it seems you cannot do
>
>   (describe-function #'#')

So to say, the reader macro #' requires an argument (i.e. the following
form), and the inner one above doesn't provide one, so you get a read
error.

Michael.