diff options
| author | Eli Zaretskii | 2016-11-05 10:54:15 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2016-11-05 10:54:15 +0200 |
| commit | 3ef86fd06378f43f8d90c7c120b4fe605d187e9f (patch) | |
| tree | 1c371f1f8e77e95d0761f4424e09d849a671bfa0 | |
| parent | de51d59802b33555fb23a924a49bb782e6caa2b8 (diff) | |
| download | emacs-3ef86fd06378f43f8d90c7c120b4fe605d187e9f.tar.gz emacs-3ef86fd06378f43f8d90c7c120b4fe605d187e9f.zip | |
Clarify documentation of face attribute functions
* doc/lispref/display.texi (Attribute Functions): Make sure to
document that an omitted FRAME argument means the same as nil.
(Bug#24879)
| -rw-r--r-- | doc/lispref/display.texi | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 2e316f8a532..f94628ce105 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -2548,7 +2548,7 @@ modifying the attributes of a named face. | |||
| 2548 | This function returns the value of the @var{attribute} attribute for | 2548 | This function returns the value of the @var{attribute} attribute for |
| 2549 | @var{face} on @var{frame}. | 2549 | @var{face} on @var{frame}. |
| 2550 | 2550 | ||
| 2551 | If @var{frame} is @code{nil}, that means the selected frame | 2551 | If @var{frame} is omitted or @code{nil}, that means the selected frame |
| 2552 | (@pxref{Input Focus}). If @var{frame} is @code{t}, this function | 2552 | (@pxref{Input Focus}). If @var{frame} is @code{t}, this function |
| 2553 | returns the value of the specified attribute for newly-created frames | 2553 | returns the value of the specified attribute for newly-created frames |
| 2554 | (this is normally @code{unspecified}, unless you have specified some | 2554 | (this is normally @code{unspecified}, unless you have specified some |
| @@ -2644,8 +2644,8 @@ created frames. | |||
| 2644 | 2644 | ||
| 2645 | The following commands and functions mostly provide compatibility | 2645 | The following commands and functions mostly provide compatibility |
| 2646 | with old versions of Emacs. They work by calling | 2646 | with old versions of Emacs. They work by calling |
| 2647 | @code{set-face-attribute}. Values of @code{t} and @code{nil} for | 2647 | @code{set-face-attribute}. Values of @code{t} and @code{nil} (or |
| 2648 | their @var{frame} argument are handled just like | 2648 | omitted) for their @var{frame} argument are handled just like |
| 2649 | @code{set-face-attribute} and @code{face-attribute}. The commands | 2649 | @code{set-face-attribute} and @code{face-attribute}. The commands |
| 2650 | read their arguments using the minibuffer, if called interactively. | 2650 | read their arguments using the minibuffer, if called interactively. |
| 2651 | 2651 | ||
| @@ -2714,7 +2714,8 @@ name used for @var{character}. | |||
| 2714 | @defun face-foreground face &optional frame inherit | 2714 | @defun face-foreground face &optional frame inherit |
| 2715 | @defunx face-background face &optional frame inherit | 2715 | @defunx face-background face &optional frame inherit |
| 2716 | These functions return the foreground color (or background color, | 2716 | These functions return the foreground color (or background color, |
| 2717 | respectively) of face @var{face}, as a string. | 2717 | respectively) of face @var{face}, as a string. If the color is |
| 2718 | unspecified, they return @code{nil}. | ||
| 2718 | @end defun | 2719 | @end defun |
| 2719 | 2720 | ||
| 2720 | @defun face-stipple face &optional frame inherit | 2721 | @defun face-stipple face &optional frame inherit |