bug#45170: docstring for set-frame-size, set-frame-width, set-frame-height

bug#45170: docstring for set-frame-size, set-frame-width, set-frame-height

[Pankaj Jangid]

[-- Attachment #1: Type: text/plain, Size: 899 bytes --]

Tags: patch

Similar to "set-frame-parameter" docstring, added a line in the
docstring of following three functions to specify that if FRAME is nil
then it defaults to selected-frame.
    
    1. set-frame-size
    2. set-frame-width
    3. set-frame-height



In GNU Emacs 28.0.50 (build 1, x86_64-apple-darwin20.1.0, NS appkit-2022.10 Version 11.0.1 (Build 20B29))
 of 2020-12-11 built on mb2.local
Repository revision: 34dff46775eec605f261cb5835798a3e5decb86f
Repository branch: gnus-summary-brackets
Windowing system distributor 'Apple', version 10.3.2022
System Description:  macOS 11.0.1

Configured using:
 'configure LDFLAGS=-L/usr/local/opt/ruby/lib
 CPPFLAGS=-I/usr/local/opt/ruby/include
 PKG_CONFIG_PATH=:/usr/local/opt/sqlite/lib/pkgconfig:/usr/local/opt/libxml2/lib/pkgconfig:/usr/local/opt/openssl/lib/pkgconfig:/usr/local/opt/libffi/lib/pkgconfig:/usr/local/opt/ruby/lib/pkgconfig'


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-docstring-If-FRAME-is-nil-it-defaults-to-selected-fr.patch --]
[-- Type: text/patch, Size: 2227 bytes --]

From 9250823257cf7c6c56b46da13fb03922525f2087 Mon Sep 17 00:00:00 2001
From: Pankaj Jangid <pankaj@codeisgreat.org>
Date: Fri, 11 Dec 2020 10:27:58 +0530
Subject: [PATCH] docstring: If FRAME is nil, it defaults to selected frame.

Similar to "set-frame-parameter" docstring, added a line in the
docstring of following three functions to specify that if FRAME is nil
then it defaults to selected-frame.

1. set-frame-size
2. set-frame-width
3. set-frame-height
---
 src/frame.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/src/frame.c b/src/frame.c
index 17ec455d2d..ecb9251c1a 100644
--- a/src/frame.c
+++ b/src/frame.c
@@ -3577,7 +3577,9 @@ DEFUN ("set-frame-height", Fset_frame_height, Sset_frame_height, 2, 4,
 multiple of the default frame font height.
 
 When called interactively, HEIGHT is the numeric prefix and the
-currently selected frame will be set to this height.  */)
+currently selected frame will be set to this height.
+
+If FRAME is nil, it defaults to the selected frame. */)
   (Lisp_Object frame, Lisp_Object height, Lisp_Object pretend, Lisp_Object pixelwise)
 {
   struct frame *f = decode_live_frame (frame);
@@ -3600,7 +3602,10 @@ DEFUN ("set-frame-width", Fset_frame_width, Sset_frame_width, 2, 4,
 multiple of the default frame font width.
 
 When called interactively, WIDTH is the numeric prefix and the
-currently selected frame will be set to this width.    */)
+currently selected frame will be set to this width.
+
+If FRAME is nil, it defaults to the selected frame.
+ */)
   (Lisp_Object frame, Lisp_Object width, Lisp_Object pretend, Lisp_Object pixelwise)
 {
   struct frame *f = decode_live_frame (frame);
@@ -3616,7 +3621,7 @@ DEFUN ("set-frame-size", Fset_frame_size, Sset_frame_size, 3, 4, 0,
 When `frame-resize-pixelwise' is nil, some window managers may refuse to
 honor a WIDTH that is not an integer multiple of the default frame font
 width or a HEIGHT that is not an integer multiple of the default frame
-font height.  */)
+font height.  If FRAME is nil, it defaults to the selected frame. */)
   (Lisp_Object frame, Lisp_Object width, Lisp_Object height, Lisp_Object pixelwise)
 {
   struct frame *f = decode_live_frame (frame);
-- 
2.29.2


[-- Attachment #3: Type: text/plain, Size: 98 bytes --]


-- 
Regards,
Pankaj Jangid

GnuPG Fingerprint: 0B62 7424 3B26 A911 052A DDE6 7C95 6E6F F858 7689

bug#45170: docstring for set-frame-size, set-frame-width, set-frame-height

[Lars Ingebrigtsen]

Pankaj Jangid <pankaj@codeisgreat.org> writes:

> Tags: patch
>
> Similar to "set-frame-parameter" docstring, added a line in the
> docstring of following three functions to specify that if FRAME is nil
> then it defaults to selected-frame.
>
>     1. set-frame-size
>     2. set-frame-width
>     3. set-frame-height

Thanks; applied to Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no