[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#59379: 29.0.50; `define-advice' documentation needs improving
From: |
Stefan Kangas |
Subject: |
bug#59379: 29.0.50; `define-advice' documentation needs improving |
Date: |
Sat, 19 Nov 2022 05:52:41 -0800 |
Visuwesh <visuweshm@gmail.com> writes:
>> 3. This is its argument list:
>>
>> (define-advice SYMBOL (HOW LAMBDA-LIST &optional NAME DEPTH) &rest
>> BODY)
>>
>> The HOW, LAMBDA-LIST, NAME, DEPTH parameters are not documented in
>> the docstring, nor in the info manual.
>
> HOW, LAMBDA-LIST, NAME, and DEPTH arguments become clear when once looks
> up the add-function docstring, and the docstring already mentions
> add-function.
Then that should be explicitly stated.
And LAMBDA-LIST is not explained there either, AFAICT.
>> 5. The documentation of NAME says that: "The advice is an anonymous
>> function if NAME is ‘nil’ or a function named ‘symbol@name’."
>>
>> I struggle with parsing this sentence. It sounds like it is saying
>> that, if I want an anonymous function, I should define a function
>> named `symbol@name' (substituting `symbol' and `name') and then pass
>> that argument as the NAME argument? But then the function is not
>> anonymous?
>
> Would a comma help before the "or"? i.e.,
>
> The advice is an anonymous function if NAME is ‘nil’, or a function
> named ‘symbol@name’.
So it can be either nil or a symbol? How do I actually use it?
> Changing symbol@name to SYMBOL@NAME like in the docstring will make it
> clearer, I think. If still not clear, the following happens in the case
> of NAME being nil vs. non-nil
>
> NAME nil ==> (advice-add SYMBOL HOW (lambda LAMBDA-LIST BODY) ...)
> NAME non-nil ==> (advice-add SYMBOL HOW (defun SYMBOL@NAME LAMBDA-LIST
> BODY) ...)
This all needs to be explained clearly in the documentation.