unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#12323: 24.2.50; doc string of `get-text-property'
@ 2012-09-01 17:13 Drew Adams
  2012-09-07 14:45 ` Chong Yidong
  0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2012-09-01 17:13 UTC (permalink / raw)
  To: 12323

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@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'
 






^ permalink raw reply	[flat|nested] 2+ messages in thread

* bug#12323: 24.2.50; doc string of `get-text-property'
  2012-09-01 17:13 bug#12323: 24.2.50; doc string of `get-text-property' Drew Adams
@ 2012-09-07 14:45 ` Chong Yidong
  0 siblings, 0 replies; 2+ messages in thread
From: Chong Yidong @ 2012-09-07 14:45 UTC (permalink / raw)
  To: Drew Adams; +Cc: 12323

"Drew Adams" <drew.adams@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.





^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2012-09-07 14:45 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-09-01 17:13 bug#12323: 24.2.50; doc string of `get-text-property' Drew Adams
2012-09-07 14:45 ` Chong Yidong

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).