GNU bug report logs - #12323
24.2.50; doc string of `get-text-property'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 12323 in the body.
You can then email your comments to 12323 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.2.50; doc string of `get-text-property'
Date: Sat, 1 Sep 2012 10:13:14 -0700

Just like in the Elisp manual, the doc string should say what parameter
OBJECT is.  It should say that it is a buffer or a string.
 
An uninformed reader could easily imagine that it might be something
else, such as a character.  (Yes, a reader who knows what strings and
chars are will not make that mistake.  Nevertheless, the doc string
should describe the acceptable OBJECT values.)
 

In GNU Emacs 24.2.50.1 (i386-mingw-nt5.1.2600)
 of 2012-08-26 on MARVIN
Bzr revision: 109788 dmantipov <at> yandex.ru-20120827041533-3cy7pdjdqz14o90c
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.6) --no-opt --enable-checking --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-3.0.9/include
 -ID:/devel/emacs/libs/libiconv-1.13.1-1-dev/include
 -ID:/devel/emacs/libs/libxml2-2.7.8/include/libxml2'
 

Message #8 received at 12323 <at> debbugs.gnu.org (full text, mbox):

From: Chong Yidong <cyd <at> gnu.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 12323 <at> debbugs.gnu.org
Subject: Re: bug#12323: 24.2.50; doc string of `get-text-property'
Date: Fri, 07 Sep 2012 22:45:36 +0800

"Drew Adams" <drew.adams <at> oracle.com> writes:

> Just like in the Elisp manual, the doc string should say what parameter
> OBJECT is.  It should say that it is a buffer or a string.

Fixed in trunk.

Previous Next

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