summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2020-12-19 20:54:11 +0200
committerEli Zaretskii <eliz@gnu.org>2020-12-19 20:54:11 +0200
commit52b30834fb1cf7bb20ed08ec8dc7d2d9b8a770e6 (patch)
tree59f93200e61fea5b4a9ff21f2731f38dbeea0701
parentb3fe0ac62e97ea2e05fc2767989dbd7e83bc0e5c (diff)
downloademacs-52b30834fb1cf7bb20ed08ec8dc7d2d9b8a770e6.tar.gz
* lisp/face-remap.el (face-remap-set-base): Doc fix. (Bug#45264)
-rw-r--r--lisp/face-remap.el12
1 files changed, 6 insertions, 6 deletions
diff --git a/lisp/face-remap.el b/lisp/face-remap.el
index 028269a4b0c..cfda6428c3a 100644
--- a/lisp/face-remap.el
+++ b/lisp/face-remap.el
@@ -33,7 +33,7 @@
;;
;; (face RELATIVE_SPECS_1 RELATIVE_SPECS_2 ... BASE_SPECS)
;;
-;; The "specs" values are a lists of face names or face attribute-value
+;; The "specs" values are lists of face names or face attribute-value
;; pairs, and are merged together, with earlier values taking precedence.
;;
;; The RELATIVE_SPECS_* values are added by `face-remap-add-relative'
@@ -183,13 +183,13 @@ to apply on top of the normal definition of FACE."
This causes the remappings specified by `face-remap-add-relative'
to apply on top of the face specification given by SPECS.
-The remaining arguments, SPECS, should form a list of faces.
-Each list element should be either a face name or a property list
+The remaining arguments, SPECS, specify the base of the remapping.
+Each one of SPECS should be either a face name or a property list
of face attribute/value pairs, like in a `face' text property.
-If SPECS is empty, call `face-remap-reset-base' to use the normal
-definition of FACE as the base remapping; note that this is
-different from SPECS containing a single value nil, which means
+If SPECS is empty or a single face `eq' to FACE, call `face-remap-reset-base'
+to use the normal definition of FACE as the base remapping; note that
+this is different from SPECS containing a single value nil, which means
not to inherit from the global definition of FACE at all."
(while (and (consp specs) (not (null (car specs))) (null (cdr specs)))
(setq specs (car specs)))