[elpa] externals/pulsar db89c709f4 05/10: Document the user option pulsar-resolve-pulse-function-aliases

[ELPA Syncer]

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

    Document the user option pulsar-resolve-pulse-function-aliases
    
    This was contributed by shipmints in pull request 12:
    <https://github.com/protesilaos/pulsar/pull/12>.
---
 README.org | 10 ++++++++++
 pulsar.el  | 17 +++++++++++++----
 2 files changed, 23 insertions(+), 4 deletions(-)

diff --git a/README.org b/README.org
index f937d1de77..be2d82fa48 100644
--- a/README.org
+++ b/README.org
@@ -74,6 +74,16 @@ in the user option ~pulsar-pulse-functions~ and the effect 
takes place
 when either ~pulsar-mode~ (buffer-local) or ~pulsar-global-mode~ is
 enabled.
 
+#+vindex; pulsar-resolve-pulse-function-aliases
+By default, Pulsar does not try behave the same way for a function's
+aliases. If those are no added explicitly to the ~pulsar-pulse-functions~,
+they will not have a pulse effect. However, the user option
+~pulsar-resolve-pulse-function-aliases~ can be set to a non-nil value
+to change this behaviour, meaning that Pulsar will cover a function's
+aliases even if those are not explicitly added to the ~pulsar-pulse-functions~.
+[ The ~pulsar-resolve-pulse-function-aliases~ is part of
+  {{{development-version}}}. ]
+
 #+vindex: pulsar-delay
 #+vindex: pulsar-iterations
 #+vindex: pulsar-face
diff --git a/pulsar.el b/pulsar.el
index c984bc0d31..814ab9f014 100644
--- a/pulsar.el
+++ b/pulsar.el
@@ -32,6 +32,14 @@
 ;; takes place when either `pulsar-mode' (buffer-local) or
 ;; `pulsar-global-mode' is enabled.
 ;;
+;; By default, Pulsar does not try behave the same way for a
+;; function's aliases.  If those are no added explicitly to the
+;; `pulsar-pulse-functions', they will not have a pulse effect.
+;; However, the user option `pulsar-resolve-pulse-function-aliases'
+;; can be set to a non-nil value to change this behaviour, meaning
+;; that Pulsar will cover a function's aliases even if those are not
+;; explicitly added to the `pulsar-pulse-functions'.
+;;
 ;; The overall duration of the highlight is determined by a combination
 ;; of `pulsar-delay' and `pulsar-iterations'.  The latter determines the
 ;; number of blinks in a pulse, while the former sets their delay in
@@ -132,11 +140,12 @@ This only takes effect when `pulsar-mode' (buffer-local) 
or
   :group 'pulsar)
 
 (defcustom pulsar-resolve-pulse-function-aliases nil
-  "When non-nil, resolve function aliases in pulsar-pulse-functions.
-This allows pulsar to respect, e.g., tab-new's \"parent,\" tab-bar-new-tab,
-and vice-versa, enabling pulsar to respect tab-bar-new-tab's alias tab-new."
+  "When non-nil, resolve function aliases in `pulsar-pulse-functions'.
+This allows pulsar to respect, e.g., `tab-new' \"parent,\"
+`tab-bar-new-tab', and vice-versa, enabling Pulsar to respect
+`tab-bar-new-tab' alias `tab-new'."
   :type 'boolean
-  :package-version '(pulsar . "1.0.2")
+  :package-version '(pulsar . "1.1.0")
   :group 'pulsar)
 
 (make-obsolete 'pulsar-pulse-on-window-change nil "0.5.0")