GNU bug report logs - #3277
23.0.93; doc string of set-frame-parameter

Previous Next

Full log

Message #11 received at 3277-done <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Chong Yidong'" <cyd <at> stupidchicken.com>
Cc: <3277-done <at> debbugs.gnu.org>
Subject: RE: 23.0.93; doc string of set-frame-parameter
Date: Thu, 14 May 2009 00:43:42 -0700

> From: Chong Yidong Sent: Wednesday, May 13, 2009 8:28 PM
> > "If FRAME is nil, it defaults to the selected frame."
> > 
> > No. If FRAME is nil, then there is no argument defaulting. It should
> > say that if FRAME is nil, the selected frame is used.
> 
> This is standard usage in many docstrings.  There is no risk of
> confusion.

What is "standard usage in many doc strings" is to say that by default, the
selected frame is used, where "by default" refers to the _absence_ of an
optional arg. There is no optional argument here.

This is not just about possible confusion; it's about English and logic.

"It", in "it defaults to", can only refer to the argument FRAME. The value of
FRAME remains nil in that case. 

The _default behavior_ of the function, that is, the behavior when FRAME is nil,
is to use the selected frame. But "it" - the value of parameter FRAME does not
default to anything. There is no parameter defaulting involved here.

What needs to be said is simply that a nil value of FRAME means that the
selected frame is used. 

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.