GNU bug report logs - #39979
28.0.50; `mouse-wheel-tilt-scroll' docstring is unclear/incomplete

Previous Next

Full log

Message #11 received at 39979 <at> debbugs.gnu.org (full text, mbox):

From: Göktuğ Kayaalp <self <at> gkayaalp.com>
To: martin rudalics <rudalics <at> gmx.at>
Cc: 39979 <at> debbugs.gnu.org
Subject: Re: bug#39979: 28.0.50; `mouse-wheel-tilt-scroll' docstring is
 unclear/incomplete
Date: Tue, 10 Mar 2020 19:39:43 +0300

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

On 2020-03-09 10:02 +01, martin rudalics <rudalics <at> gmx.at> wrote:
>  > A patch is attached which is proposed as a tentative improvement. If
>  > it’s good enough to apply, I do have my copyright assingment paperwork
>  > done so it can be committed right away.
>
> Thanks for looking into this.  But
>
> -  "Enable scroll using tilting mouse wheel."
> +  "Enable horizontal scrolling via mouse or touchpad. Also see
> +  ‘mouse-wheel-flip-direction’."
>
> violates the rule from D.6 of the Elisp manual:
>
>   The first line of the documentation string should consist of one or
>       two complete sentences that stand on their own as a summary.

New patch added, with some improvement to the ‘...-flip-direction’
variable too.

> Also, 'mouse-wheel-flip-direction' does not have a great doc-string
> either.  Maybe we should add a reference to section 21.1 of the Emacs
> manual?

There is this, assuming you meant "(emacs) Mouse Commands":

,----
|    Emacs can also support horizontal scrolling if your mouse’s wheel can
| be tilted.  This feature is off by default; the variable
| ‘mouse-wheel-tilt-scroll’ turns it on.  If you’d like to reverse the
| direction of horizontal scrolling, customize the variable
| ‘mouse-wheel-flip-direction’ to a non-‘nil’ value.
`----

I think a little mention of touchpads would suffice.  The added patch
addresses this too.

Cheers,

        -gk.

P.S. I never know if it’s better to send Debbugs patches inline or as
attachments.  Sorry if I’m doing the wrong thing.

[0001-Improve-docs-for-horizontal-scrolling-with-mouse-and.patch (text/x-diff, attachment)]

Previous Next

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