branch: externals/cursory
commit 9961480a24ec751c1980dd77c8c3b056439e6e06
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update package Commentary
---
cursory.el | 32 ++++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
diff --git a/cursory.el b/cursory.el
index c5d7293bb0..f08b05530a 100644
--- a/cursory.el
+++ b/cursory.el
@@ -55,6 +55,38 @@
;; The value each property accepts is the same as the variable it
;; references.
;;
+;; A property of `:blink-cursor-mode' is also available. It is a numeric
+;; value of either `1' or `-1' and is given to the function
+;; `blink-cursor-mode' (`1' is to enable, `-1' is to disable the mode).
+;;
+;; A preset whose car is `t' is treated as the default option. This makes
+;; it possible to specify multiple presets without duplicating their
+;; properties. The other presets beside `t' act as overrides of the
+;; defaults and, as such, need only consist of the properties that change
+;; from the default. See the original value of this variable for how that
+;; is done:
+;;
+;; (defcustom cursory-presets
+;; '((box
+;; :blink-cursor-interval 0.8)
+;; (box-no-blink
+;; :blink-cursor-mode -1)
+;; (bar
+;; :cursor-type (bar . 2)
+;; :blink-cursor-interval 0.5)
+;; (underscore
+;; :cursor-type (hbar . 3)
+;; :blink-cursor-blinks 50)
+;; (t ; the default values
+;; :cursor-type box
+;; :cursor-in-non-selected-windows hollow
+;; :blink-cursor-mode 1
+;; :blink-cursor-blinks 10
+;; :blink-cursor-interval 0.2
+;; :blink-cursor-delay 0.2))
+;; ;; Omitting the doc string for demo purposes
+;; )
+;;
;; When called from Lisp, the `cursory-set-preset' command requires a
;; PRESET argument, such as:
;;
