GNU bug report logs - #32863
Unsatisfactory "definition" of "vertical scroll position" in Emacs lisp manual and doc string of window-vscroll

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Alan Mackenzie <acm <at> muc.de>
Subject: bug#32863: closed (Re: bug#32863: Unsatisfactory "definition" of
 "vertical scroll position" in Emacs lisp manual and doc string of
 window-vscroll)
Date: Mon, 15 Oct 2018 19:22:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#32863: Unsatisfactory "definition" of "vertical scroll position" in Emacs lisp manual and doc string of window-vscroll

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 32863 <at> debbugs.gnu.org.

-- 
32863: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=32863
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Alan Mackenzie <acm <at> muc.de>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 32863-done <at> debbugs.gnu.org
Subject: Re: bug#32863: Unsatisfactory "definition" of "vertical scroll
 position" in Emacs lisp manual and doc string of window-vscroll
Date: Mon, 15 Oct 2018 19:13:54 +0000

Hello, Eli.

On Mon, Oct 15, 2018 at 21:47:34 +0300, Eli Zaretskii wrote:
> > Date: Mon, 15 Oct 2018 18:33:01 +0000
> > Cc: 32863 <at> debbugs.gnu.org
> > From: Alan Mackenzie <acm <at> muc.de>

> > OK, amended (final?) version:

> LGTM, thanks.

I've committed it, and I'm closing the bug.

-- 
Alan Mackenzie (Nuremberg, Germany).

[Message part 3 (message/rfc822, inline)]

From: Alan Mackenzie <acm <at> muc.de>
To: bug-gnu-emacs <at> gnu.org
Subject: Unsatisfactory "definition" of "vertical scroll position" in Emacs
 lisp manual and doc string of window-vscroll
Date: Fri, 28 Sep 2018 15:28:32 +0000

Hello, Emacs.

In the Emacs-26.1 Emacs Lisp manual, on page "Vertical Scrolling" there
is an ostensible definition for "vertical scroll position".

This "definition" says it "is a number, never less than zero.  It
specifies how far to raise the contents of the window."

What should be doing this raising?  When might it do this?  For what
purpose might the contents of the window be raised?

I find this "definition" totally obscure.  I can not make sense of it at
all.  Without understanding what "vertical scroll position" means, the
entire manual page is meaningless.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

I came to this manual page through not understanding the doc string for
the function window-vscroll.  This says just "Return the amount by which
WINDOW is scrolled vertically.".

_Is_ scrolled vertically.  What on earth does that mean?  What is the
zero point from which this scrolling is measured?  Does this "is" refer
to the current visible scrolling, or the intended scrolling after the
next redisplay?

This doc string needs clarification.

-- 
Alan Mackenzie (Nuremberg, Germany).

Previous Next

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