summaryrefslogtreecommitdiff
path: root/lisp/custom.el
diff options
context:
space:
mode:
authorDaniel Colascione <dancol@dancol.org>2018-06-12 23:28:47 -0700
committerDaniel Colascione <dancol@dancol.org>2018-06-12 23:28:47 -0700
commitb8478b2ab7ad19c629da9c6b0dfd9a6544a6acee (patch)
tree611c85ab29c47bf3acc2e4c6e0e84bac721c6c8e /lisp/custom.el
parent5ed119141d10a09c4cd767c42a25a285f4f844ce (diff)
downloademacs-b8478b2ab7ad19c629da9c6b0dfd9a6544a6acee.tar.gz
Clarify that enabling a theme does not disable other themes
Avoid user confusion by explicitly stating that enabling a theme does not imply disabling other themes and that theme load functions are not theme switch functions. * lisp/custom.el (load-theme, enable-theme): Clarify docstrings.
Diffstat (limited to 'lisp/custom.el')
-rw-r--r--lisp/custom.el13
1 files changed, 11 insertions, 2 deletions
diff --git a/lisp/custom.el b/lisp/custom.el
index b7539685a89..2a489c4f5b3 100644
--- a/lisp/custom.el
+++ b/lisp/custom.el
@@ -1184,7 +1184,7 @@ This variable cannot be set in a Custom theme."
:version "24.1")
(defun load-theme (theme &optional no-confirm no-enable)
- "Load Custom theme named THEME from its file.
+ "Load Custom theme named THEME from its file and possibly enable it.
The theme file is named THEME-theme.el, in one of the directories
specified by `custom-theme-load-path'.
@@ -1197,6 +1197,11 @@ Normally, this function also enables THEME. If optional arg
NO-ENABLE is non-nil, load the theme but don't enable it, unless
the theme was already enabled.
+Note that enabling THEME does not disable any other
+already-enabled themes. If THEME is enabled, it has the highest
+precedence (after `user') among enabled themes. To disable other
+themes, use `disable-theme'.
+
This function is normally called through Customize when setting
`custom-enabled-themes'. If used directly in your init file, it
should be called with a non-nil NO-CONFIRM argument, or after
@@ -1324,8 +1329,12 @@ variable `custom-known-themes'."
(defun enable-theme (theme)
"Reenable all variable and face settings defined by THEME.
THEME should be either `user', or a theme loaded via `load-theme'.
+
After this function completes, THEME will have the highest
-precedence (after `user')."
+precedence (after `user') among enabled themes.
+
+Note that any already-enabled themes remain enabled after this
+function runs. To disable other themes, use `disable-theme'."
(interactive (list (intern
(completing-read
"Enable custom theme: "