diff options
author | Eli Zaretskii <eliz@gnu.org> | 2015-12-11 10:46:18 +0200 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2015-12-11 10:46:18 +0200 |
commit | 1db9d8bd0fb41bda3cc8027ec0cf27aade71b400 (patch) | |
tree | fee1506360acc80212fa24fd2add5e93b94c480b /doc | |
parent | b3277c7d3913ccedfac36c27ab657901e4f131b4 (diff) | |
download | emacs-1db9d8bd0fb41bda3cc8027ec0cf27aade71b400.tar.gz |
Clarify documentation of 'modify-frame-parameters'
* doc/lispref/frames.texi (Parameter Access): Clarify what "ignored
PARMs" mean for 'modify-frame-parameters'.
* src/frame.c (Fmodify_frame_parameters): Clarify what "ignored
PARMs" mean for this function. (Bug#22104)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/frames.texi | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 3c1a87a314f..b6f07200bfb 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi @@ -1001,12 +1001,18 @@ parameters of @var{frame} and their values. If @var{frame} is @end defun @defun modify-frame-parameters frame alist -This function alters the parameters of frame @var{frame} based on the -elements of @var{alist}. Each element of @var{alist} has the form -@code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a -parameter. If you don't mention a parameter in @var{alist}, its value -doesn't change. If @var{frame} is @code{nil}, it defaults to the selected -frame. +This function alters the frame @var{frame} based on the elements of +@var{alist}. Each element of @var{alist} has the form +@code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming +a parameter. If you don't mention a parameter in @var{alist}, its +value doesn't change. If @var{frame} is @code{nil}, it defaults to +the selected frame. + +Some parameters are only meaningful for frames on certain kinds of +display (@pxref{Frames}). If @var{alist} includes parameters that are +not meaningful for the @var{frame}'s display, this function will +change its value in the frame's parameter list, but will otherwise +ignore it. @end defun @defun set-frame-parameter frame parm value |