bug#21820: 25.0.50; doc string of `set-mouse-position' should mention return value

bug#21820: 25.0.50; doc string of `set-mouse-position' should mention return value

[Drew Adams]

Subject line says it all.  Please mention that the value
you set is what the function returns.

In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2015-10-30
Repository revision: cadfceab1aaafaf2a1fd4f7a27fe488e9a06c3ae
Windowing system distributor 'Microsoft Corp.', version 6.1.7601
Configured using:
 'configure --prefix=/c/Devel/emacs/snapshot/trunk
 --enable-checking=yes,glyphs --enable-check-lisp-object-type
 --without-compress-install --with-wide-int 'CFLAGS=-O0 -ggdb3'
 LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
 -Ic:/Devel/emacs/include''

Configured features:
XPM JPEG TIFF GIF PNG RSVG SOUND NOTIFY ACL GNUTLS LIBXML2 ZLIB
TOOLKIT_SCROLL_BARS

Important settings:
  value of $LANG: ENU
  locale-coding-system: cp1252

Major mode: Dired by name

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  buffer-read-only: t
  line-number-mode: t
  transient-mark-mode: t

Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.

Load-path shadows:
None found.

Features:
(shadow sort gnus-util mail-extr emacsbug message format-spec rfc822 mml
mml-sec mm-decode mm-bodies mm-encode mail-parse rfc2231 mailabbrev
gmm-utils mailheader sendmail rfc2047 rfc2045 ietf-drums mm-util
help-fns help-mode easymenu cl-loaddefs pcase cl-lib mail-prsvr
mail-utils dired time-date mule-util tooltip eldoc electric uniquify
ediff-hook vc-hooks lisp-float-type mwheel dos-w32 ls-lisp disp-table
w32-win w32-vars term/common-win tool-bar dnd fontset image regexp-opt
fringe tabulated-list newcomment elisp-mode lisp-mode prog-mode register
page menu-bar rfn-eshadow timer select scroll-bar mouse jit-lock
font-lock syntax facemenu font-core frame cl-generic cham georgian
utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao korean
japanese eucjp-ms cp51932 hebrew greek romanian slovak czech european
ethiopic indian cyrillic chinese charscript case-table epa-hook
jka-cmpr-hook help simple abbrev minibuffer cl-preloaded nadvice
loaddefs button faces cus-face macroexp files text-properties overlay
sha1 md5 base64 format env code-pages mule custom widget
hashtable-print-readable backquote w32notify w32 multi-tty
make-network-process emacs)

Memory information:
((conses 16 165207 36661)
 (symbols 56 19083 0)
 (miscs 48 53 65)
 (strings 16 14570 5275)
 (string-bytes 1 393529)
 (vectors 16 10698)
 (vector-slots 8 407390 6787)
 (floats 8 132 281)
 (intervals 40 30521 6947)
 (buffers 856 13))

bug#21820: 25.0.50; doc string of `set-mouse-position' should mention return value

[Eli Zaretskii]

> Date: Tue, 3 Nov 2015 08:54:12 -0800 (PST)
> From: Drew Adams <drew.adams@oracle.com>
> 
> Subject line says it all.  Please mention that the value
> you set is what the function returns.

Maybe I'm blind, but here it always returns nil, both in the code and
in practice.

bug#21820: 25.0.50; doc string of `set-mouse-position' should mention return value

[Drew Adams]

> > Subject line says it all.  Please mention that the value
> > you set is what the function returns.
> 
> Maybe I'm blind, but here it always returns nil, both in the code and
> in practice.

My bad.  I should have tested.

Was misled by this:
http://stackoverflow.com/q/33501149/729907
which uses this sexp:
(list (set-mouse-position (selected-frame) 4 4) (mouse-position))

Presumably, `progn' was meant instead of `list'.

I'll close this bug.