[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/pulsar 1b73a123f1 21/28: Reword Commentary and package
From: |
ELPA Syncer |
Subject: |
[elpa] externals/pulsar 1b73a123f1 21/28: Reword Commentary and package description |
Date: |
Tue, 22 Mar 2022 06:58:05 -0400 (EDT) |
branch: externals/pulsar
commit 1b73a123f164112b3ae236a152936bc9c489fa67
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Reword Commentary and package description
---
pulsar.el | 23 ++++++++++++++---------
1 file changed, 14 insertions(+), 9 deletions(-)
diff --git a/pulsar.el b/pulsar.el
index fe40b44226..15458dc9bd 100644
--- a/pulsar.el
+++ b/pulsar.el
@@ -1,4 +1,4 @@
-;;; pulsar.el --- Pulse line after running select functions -*-
lexical-binding: t -*-
+;;; pulsar.el --- Pulse highlight on demand or after select functions -*-
lexical-binding: t -*-
;; Copyright (C) 2022 Free Software Foundation, Inc.
@@ -26,15 +26,19 @@
;;; Commentary:
;;
;; This is a small package that temporarily highlights the current line
-;; after a given function is invoked. The affected functions are defined
-;; in the user option `pulsar-pulse-functions'. What Pulsar does is set up
-;; an advice so that those functions run a hook after they are called.
-;; The pulse effect is added there (`pulsar-after-function-hook').
+;; either on demand or after a given function is invoked. The affected
+;; functions are defined in the user option `pulsar-pulse-functions'.
+;; What Pulsar does is set up an advice so that those functions run a
+;; hook after they are called. The pulse effect is added there
+;; (`pulsar-after-function-hook').
;;
-;; The duration of the highlight is determined by `pulsar-delay'. While
-;; the applicable face is specified in `pulsar-face'.
+;; The duration of the highlight is determined by `pulsar-delay'. The
+;; steps of the pulse effect are controlled by `pulsar-iterations'.
+;; While the applicable face is specified in `pulsar-face'.
;;
-;; To highlight the current line on demand, use `pulsar-pulse-line'.
+;; To pulse highlight the current line on demand, use
+;; `pulsar-pulse-line'. To highlight the current line without pulsing
+;; it, use `pulsar-highlight-line' instead.
;;
;; Pulsar depends on the built-in `pulse.el' library.
;;
@@ -47,7 +51,8 @@
(require 'pulse)
(defgroup pulsar ()
- "Extensions for `pulse.el'."
+ "Pulse highlight line on demand or after running select functions.
+Extension of `pulse.el'."
:group 'editing)
;;;; User options
- [elpa] externals/pulsar fca0e53815 15/28: Exert control over the pulse effect, (continued)
- [elpa] externals/pulsar fca0e53815 15/28: Exert control over the pulse effect, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 486645f81b 16/28: Always ':extend t' the generic pulse face, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar dcc94662a9 07/28: Stop pulsing during pulsar-reveal-entry, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 82946880b5 14/28: Add missing function to sample package setup, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 42f8a03b8a 18/28: Fix typo, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar d654e552f0 19/28: Clarify doc strings of user options, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 4cfc18a009 22/28: Update to version 0.2.0, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar d2174307b0 23/28: Simple fix for highlight behavior on last line, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 2d666c7061 25/28: Update "Acknowledgements" in the manual, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 1535551ac0 27/28: Use post-command-hook instead of an advice, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 1b73a123f1 21/28: Reword Commentary and package description,
ELPA Syncer <=
- [elpa] externals/pulsar b469abdd94 17/28: Abstract pulse effect; add pulsar-highlight-line, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 890d73e481 24/28: Merge branch 'fix-last-line' into 'main', ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 0891269ff8 26/28: Add pulsar-highlight-face user option, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar ebbe9486d1 20/28: Reword manual's description, ELPA Syncer, 2022/03/22
- [elpa] externals/pulsar 40b1aa8c48 28/28: Document pulsar package installation, ELPA Syncer, 2022/03/22