emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/pulsar b6bbe57d06 14/15: Tweak the doc strings of the f


From: ELPA Syncer
Subject: [elpa] externals/pulsar b6bbe57d06 14/15: Tweak the doc strings of the functions that deal with aliases
Date: Tue, 26 Nov 2024 03:58:52 -0500 (EST)

branch: externals/pulsar
commit b6bbe57d0654b547ea3f7e315f650e5b0189f6c1
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>

    Tweak the doc strings of the functions that deal with aliases
---
 pulsar.el | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/pulsar.el b/pulsar.el
index 1191fd7202..57012e7cb7 100644
--- a/pulsar.el
+++ b/pulsar.el
@@ -593,12 +593,13 @@ Changes are defined by BEG, END, LEN:
 
 (make-obsolete 'pulsar-setup nil "0.3.0")
 
-;; Lifted from Emacs 30 to allow pulsar to remain backward compatible
-;; with Emacs earlier than Emacs 29.1. TODO: Deprecate this at some
-;; point to prefer Emacs core.
+;; TODO 2024-11-26: Deprecate this at some point to prefer Emacs core.
 (defun pulsar--function-alias-p (func &optional _noerror)
   "Return nil if FUNC is not a function alias.
-If FUNC is a function alias, return the function alias chain."
+If FUNC is a function alias, return the function alias chain.
+
+This is a copy of `function-alias-p' for backward-compatibility and will
+be deleted from Pulsar in future versions of Emacs."
   (declare (advertised-calling-convention (func) "30.1")
            (side-effect-free error-free))
   (let ((chain nil))
@@ -608,10 +609,10 @@ If FUNC is a function alias, return the function alias 
chain."
       (push func chain))
     (nreverse chain)))
 
-;; This is essentially the inverse of function-alias-p for a list of
-;; function symbols.
 (defun pulsar--find-fn-aliases (fns)
-  "Return a list of aliases for the FNS symbols."
+  "Return a list of aliases for the FNS symbols.
+This is essentially the inverse of `pulsar--function-alias-p' for a list
+of function symbols."
   (let ((aliases))
     (mapatoms (lambda (sym)
                 (when (and



reply via email to

[Prev in Thread] Current Thread [Next in Thread]