timeout: Name advice functions. #9
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* lisp/timeout.el (timeout-debounce, timeout-throttle): Assign explicit names to advice functions instead of using anonymous lambdas. This makes it easier to debug the advice stack. The advice functions are given names like 'timeout-debounce-on-...' and 'timeout-throttle-on-...'.
Owner
The advice is already named via the The function itself is intentionally anonymous. I think the recommendation to use named functions applies only to hooks, not advice, because there is no other way to refer to them in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I believe it is generally considered good practice to use named functions rather than anonymous lambdas for hook-like things, like when adding functions to hook variables or defining advice. Named functions make debugging simpler, as one can readily identify their origin and location.
With this patch applied, for example, inspecting a function such as
example-funcusingC-h fimmediately shows that it is advised by atimeout-*function. The user can then further examine the advice function itself, improving traceability and clarity.