bug#45322: Documentation of mouse-wheel-progressive-speed clarification

bug#45322: Documentation of mouse-wheel-progressive-speed clarification

[Tomas Nordin]

[-- Attachment #1: Type: text/plain, Size: 807 bytes --]

Hello Emacs

Here is a little documentation improvement I think. The doc of variable
mouse-wheel-progressive-speed says

If non-nil, the faster the user moves the wheel, the faster the scrolling.
Note that this has no effect when ‘mouse-wheel-scroll-amount’ specifies
a "near full screen" scroll or when the mouse wheel sends key instead
of button events.

That explains (the first sentence) the effect when the variable is nil,
the scrolling speed is proportional to the wheel speed. When non-nil,
scrolling speed will increase (progress) the more the wheel is turned.
Isn't it.

Attached is a patch updating the docs of the variable and in info.

GNU Emacs 28.0.50 (build 2, x86_64-pc-linux-gnu, GTK+ Version 3.24.5,
cairo version 1.16.0) of 2020-12-12

Best regards
--
Tomas


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: progressive-speed-doc.patch --]
[-- Type: text/x-diff, Size: 1172 bytes --]

diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index f5e2e8d172..57b1add85b 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -210,7 +210,7 @@ Mouse Commands
 @code{mouse-wheel-scroll-amount} determine where and by how much
 buffers are scrolled.  The variable
 @code{mouse-wheel-progressive-speed} determines whether the scroll
-speed is linked to how fast you move the wheel.  This mode also
+speed is linked to how much you move the wheel.  This mode also
 supports increasing or decreasing the height of the default face, by
 default bound to scrolling with the @key{Ctrl} modifier.

diff --git a/lisp/mwheel.el b/lisp/mwheel.el
index 9fd050fea5..a0941205ba 100644
--- a/lisp/mwheel.el
+++ b/lisp/mwheel.el
@@ -131,7 +131,7 @@ mouse-wheel-scroll-amount
   :version "28.1")

 (defcustom mouse-wheel-progressive-speed t
-  "If non-nil, the faster the user moves the wheel, the faster the scrolling.
+  "If non-nil, the more the user moves the wheel, the faster the scrolling.
 Note that this has no effect when `mouse-wheel-scroll-amount' specifies
 a \"near full screen\" scroll or when the mouse wheel sends key instead
 of button events."

bug#45322: Documentation of mouse-wheel-progressive-speed clarification

[Lars Ingebrigtsen]

Tomas Nordin <tomasn@posteo.net> writes:

> That explains (the first sentence) the effect when the variable is nil,
> the scrolling speed is proportional to the wheel speed. When non-nil,
> scrolling speed will increase (progress) the more the wheel is turned.
> Isn't it.

[...]

>  (defcustom mouse-wheel-progressive-speed t
> -  "If non-nil, the faster the user moves the wheel, the faster the scrolling.
> +  "If non-nil, the more the user moves the wheel, the faster the scrolling.

Thanks for the patch, but I don't think just replacing "faster" with
"more" here clarifies all that much.  I've instead rewritten the doc
string according to your explanation in Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#45322: Documentation of mouse-wheel-progressive-speed clarification

[Tomas Nordin]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> Tomas Nordin <tomasn@posteo.net> writes:
>
>> That explains (the first sentence) the effect when the variable is nil,
>> the scrolling speed is proportional to the wheel speed. When non-nil,
>> scrolling speed will increase (progress) the more the wheel is turned.
>> Isn't it.
>
> [...]
>
>>  (defcustom mouse-wheel-progressive-speed t
>> -  "If non-nil, the faster the user moves the wheel, the faster the scrolling.
>> +  "If non-nil, the more the user moves the wheel, the faster the scrolling.
>
> Thanks for the patch, but I don't think just replacing "faster" with
> "more" here clarifies all that much.  I've instead rewritten the doc
> string according to your explanation in Emacs 28.

Thanks, I think it is less confusing and more correct now.

But still, in my experience, the progression of scroll speed is in
effect with a constant rotational speed of the mouse wheel.

>
> --
> (domestic pets only, the antidote for overdose, milk.)
>    bloggy blog: http://lars.ingebrigtsen.no

--
Tomas