]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify the documentation of 'left/right-fringe' display spec
authorEli Zaretskii <eliz@gnu.org>
Sun, 5 Jul 2020 15:30:21 +0000 (18:30 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sun, 5 Jul 2020 15:30:21 +0000 (18:30 +0300)
* doc/lispref/display.texi (Other Display Specs, Fringe Bitmaps):
Clarify how the optional FACE parameter of the left-fringe and
right-fringe display spec is used.  Reported by Gregory Heytings
<ghe@sdf.org>.

doc/lispref/display.texi

index 707a1a8dc0486e3d4c79e02b1c8c4b3dfe3f0b8e..19e0fdf0b12a65518855e3dd3ad63162e994ff00 100644 (file)
@@ -4277,9 +4277,10 @@ a display specification has the form
 @noindent
 @var{fringe} is either the symbol @code{left-fringe} or
 @code{right-fringe}.  @var{bitmap} is a symbol identifying the bitmap
-to display.  The optional @var{face} names a face whose foreground
-color is used to display the bitmap; this face is automatically merged
-with the @code{fringe} face.
+to display.  The optional @var{face} names a face whose foreground and
+background colors are to be used to display the bitmap; this face is
+automatically merged with the @code{fringe} face.  If @var{face} is
+omitted, that means to use the @code{default} face.
 
   For instance, to display an arrow in the left fringe, using the
 @code{warning} face, you could say something like:
@@ -4983,8 +4984,9 @@ Margins}).
 This display specification on any character of a line of text causes
 the specified @var{bitmap} be displayed in the left or right fringes
 for that line, instead of the characters that have the display
-specification.  The optional @var{face} specifies the colors to be
-used for the bitmap.  @xref{Fringe Bitmaps}, for the details.
+specification.  The optional @var{face} specifies the face whose
+colors are to be used for the bitmap display.  @xref{Fringe Bitmaps},
+for the details.
 
 @item (space-width @var{factor})
 This display specification affects all the space characters within the