unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Alan Mackenzie <acm@muc.de>
To: 32863@debbugs.gnu.org
Subject: bug#32863: 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	[thread overview]
Message-ID: <20180928152832.GA5172@ACM> (raw)

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).





             reply	other threads:[~2018-09-28 15:28 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-28 15:28 Alan Mackenzie [this message]
2018-09-28 21:41 ` bug#32863: Unsatisfactory "definition" of "vertical scroll position" in Emacs lisp manual and doc string of window-vscroll Eli Zaretskii
2018-10-15 11:48   ` Alan Mackenzie
2018-10-15 15:32     ` Eli Zaretskii
2018-10-15 18:33       ` Alan Mackenzie
2018-10-15 18:47         ` Eli Zaretskii
2018-10-15 19:13           ` Alan Mackenzie

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180928152832.GA5172@ACM \
    --to=acm@muc.de \
    --cc=32863@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).