diff options
author | Eli Zaretskii <eliz@gnu.org> | 2022-10-04 10:32:06 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2022-10-04 10:32:06 +0300 |
commit | 78c262e1c2cf93d3101cb942926d170a816a8d3f (patch) | |
tree | c67de4a624683766add521536be34d42be4a5435 | |
parent | 992611b10a2ef4621b5c936d80cf31644ca3653d (diff) | |
download | emacs-78c262e1c2cf93d3101cb942926d170a816a8d3f.tar.gz |
; * lisp/progmodes/glasses.el (glasses-face): Expand the doc string.
-rw-r--r-- | lisp/progmodes/glasses.el | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/lisp/progmodes/glasses.el b/lisp/progmodes/glasses.el index f760ccf3686..87bb7318d04 100644 --- a/lisp/progmodes/glasses.el +++ b/lisp/progmodes/glasses.el @@ -84,12 +84,22 @@ performed." (defcustom glasses-face nil - "Face to be put on capitals of an identifier looked through glasses. -If it is nil, no face is placed at the capitalized letter. + "Face to use for capital letters of identifiers where separators were added. +If it is nil, the capital letters will display with their usual faces. For example, you can set `glasses-separator' to an empty string and `glasses-face' to `bold'. Then unreadable identifiers will have no separators, -but will have their capitals in bold." +but will have their capitals in bold. + +As another example, you may wish to have a clear visual indication of +where the `glasses-separator' string was inserted by `glasses-mode', +as opposed to where they are part of the original identifiers. This +can be useful when the program source code uses mixed CamelCase and +normal_readable identifiers, and you want to know which underscores +were added by this mode. Customizing this face to something like `bold' +will show the capital letters following the inserted `glasses-separator' +in a distinct face. Note that you must use `customize-variable' for +changing the face; just assigning the value has no effect." :type '(choice (const :tag "None" nil) face) :set 'glasses-custom-set :initialize 'custom-initialize-default) |