[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#66928: [PATCH 2/2] Update names to match the docstring
From: |
Jeremy Bryant |
Subject: |
bug#66928: [PATCH 2/2] Update names to match the docstring |
Date: |
Mon, 06 Nov 2023 22:55:39 +0000 |
Interesting, thank you
Perhaps it would be of interest to add some text to the elisp manual in
(elisp) Function Documentation
Are there any conventions for manual additions?
in particular to keep the number of printed pages limited is there a way
to say 'don't print this node'?
thanks
Jeremy
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> One question, the elisp manual mentions that the \(fn ARGLIST) facility
>> is particularly useful for macros.
>>
>> Why would we use this for defuns?
>
> We use it for some defuns where ELisp's arglist functionality is not
> refined enough to express the intention of the programmer.
> For example, the "real" arglist may be
>
> name args &optional docstring &rest body
>
> but the intended arglist is
>
> name args [docstring] &rest body
>
> i.e. if `docstring` is not a string it's taken as the first instruction
> of `body`.
>
>
> Stefan
bug#66928: [PATCH 2/2] Update names to match the docstring, Jeremy Bryant, 2023/11/04
bug#66928: [PATCH 2/2] Update names to match the docstring, Stefan Monnier, 2023/11/12