docs(ligatures): revise docstrings

This commit is contained in:
Henrik Lissner 2024-09-12 23:18:30 -04:00
parent c07f359d64
commit f452677c55
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
2 changed files with 12 additions and 6 deletions

View file

@ -18,15 +18,17 @@ pretty symbols and ligatures previously defined for MODES.
For example, the rule for emacs-lisp-mode is very simple:
(set-ligatures! \\='emacs-lisp-mode
:lambda \"lambda\")
(after! elisp-mode
(set-ligatures! \\='emacs-lisp-mode
:lambda \"lambda\"))
This will replace any instances of \"lambda\" in emacs-lisp-mode with the symbol
associated with :lambda in `+ligatures-extra-symbols'.
Pretty symbols can be unset for emacs-lisp-mode with:
Pretty symbols can be unset by passing `nil':
(set-ligatures! \\='emacs-lisp-mode nil)
(after! rustic
(set-ligatures! \\='rustic-mode nil))
Note that this will keep all ligatures in `+ligatures-prog-mode-list' active, as
`emacs-lisp-mode' is derived from `prog-mode'."

View file

@ -59,7 +59,9 @@ font.")
"?=" "?." "??" ";;" "/*" "/=" "/>" "//" "__" "~~" "(*" "*)"
"\\\\" "://")
(t))
"A alist of ligatures to enable in specific modes.")
"A alist of ligatures to enable in specific modes.
To configure this variable, use `set-ligatures!'.")
(defvar +ligatures-in-modes nil
"List of major modes where ligatures should be enabled.")
@ -74,7 +76,9 @@ font.")
(make-obsolete-variable '+ligatures-all-modes-list "Use `+ligatures-alist' instead" "24.09.0")
(defvar +ligatures-extra-alist '((t))
"A map of major modes to symbol lists (for `prettify-symbols-alist').")
"A map of major modes to symbol lists (for `prettify-symbols-alist').
To configure this variable, use `set-ligatures!'.")
(defvar +ligatures-extras-in-modes t
"List of major modes where extra ligatures should be enabled.