From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: =?UTF-8?Q?G=C3=B6ktu=C4=9F?= Kayaalp Newsgroups: gmane.emacs.bugs Subject: bug#39979: 28.0.50; `mouse-wheel-tilt-scroll' docstring is unclear/incomplete Date: Tue, 10 Mar 2020 19:39:43 +0300 Message-ID: References: Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="84239"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 39979@debbugs.gnu.org To: martin rudalics Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Mar 10 17:41:05 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1jBhwG-000LkH-Tr for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 10 Mar 2020 17:41:05 +0100 Original-Received: from localhost ([::1]:36688 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jBhwF-0003mt-SU for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 10 Mar 2020 12:41:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35877) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jBhvH-0002vy-Oe for bug-gnu-emacs@gnu.org; Tue, 10 Mar 2020 12:40:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jBhvG-0003ET-F7 for bug-gnu-emacs@gnu.org; Tue, 10 Mar 2020 12:40:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:47215) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1jBhvG-0003Cv-A9 for bug-gnu-emacs@gnu.org; Tue, 10 Mar 2020 12:40:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1jBhvG-0004RB-89 for bug-gnu-emacs@gnu.org; Tue, 10 Mar 2020 12:40:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?G=C3=B6ktu=C4=9F?= Kayaalp Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 10 Mar 2020 16:40:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 39979 X-GNU-PR-Package: emacs Original-Received: via spool by 39979-submit@debbugs.gnu.org id=B39979.158385839517039 (code B ref 39979); Tue, 10 Mar 2020 16:40:02 +0000 Original-Received: (at 39979) by debbugs.gnu.org; 10 Mar 2020 16:39:55 +0000 Original-Received: from localhost ([127.0.0.1]:53188 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jBhv8-0004Ql-Ra for submit@debbugs.gnu.org; Tue, 10 Mar 2020 12:39:55 -0400 Original-Received: from relay6-d.mail.gandi.net ([217.70.183.198]:40161) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jBhv6-0004QW-Si for 39979@debbugs.gnu.org; Tue, 10 Mar 2020 12:39:53 -0400 X-Originating-IP: 95.70.210.195 Original-Received: from localhost (unknown [95.70.210.195]) (Authenticated sender: self@gkayaalp.com) by relay6-d.mail.gandi.net (Postfix) with ESMTPSA id CFB2BC0002; Tue, 10 Mar 2020 16:39:45 +0000 (UTC) In-Reply-To: (message from martin rudalics on Mon, 9 Mar 2020 10:02:35 +0100) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:177150 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable On 2020-03-09 10:02 +01, martin rudalics wrote: > > A patch is attached which is proposed as a tentative improvement. If > > it=E2=80=99s good enough to apply, I do have my copyright assingment p= aperwork > > 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 > + =E2=80=98mouse-wheel-flip-direction=E2=80=99." > > 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 =E2=80=98...-flip-direction= =E2=80=99 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=E2=80=99s wh= eel can | be tilted. This feature is off by default; the variable | =E2=80=98mouse-wheel-tilt-scroll=E2=80=99 turns it on. If you=E2=80=99d = like to reverse the | direction of horizontal scrolling, customize the variable | =E2=80=98mouse-wheel-flip-direction=E2=80=99 to a non-=E2=80=98nil=E2=80= =99 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=E2=80=99s better to send Debbugs patches inline or = as attachments. Sorry if I=E2=80=99m doing the wrong thing. --=-=-= Content-Type: text/x-diff; charset=utf-8 Content-Disposition: attachment; filename=0001-Improve-docs-for-horizontal-scrolling-with-mouse-and.patch Content-Transfer-Encoding: quoted-printable Content-Description: Improved patch >From 66906d5a680f61528ae1eaee1f101eecebd5a0aa Mon Sep 17 00:00:00 2001 From: =3D?UTF-8?q?=3DC4=3DB0=3D2E=3D20G=3DC3=3DB6ktu=3DC4=3D9F=3D20Kayaalp?= =3D Date: Sun, 8 Mar 2020 00:15:01 +0300 Subject: [PATCH] Improve docs for horizontal scrolling with mouse and touch= pad * lisp/mwheel.el (mouse-wheel-tilt-scroll, mouse-wheel-flip-direction): Improve docstrings. * doc/emacs/frames.texi (Mouse Commands): Mention touchpads. --- doc/emacs/frames.texi | 9 +++++---- lisp/mwheel.el | 7 +++++-- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi index 002297c259..16205e6e0c 100644 --- a/doc/emacs/frames.texi +++ b/doc/emacs/frames.texi @@ -217,10 +217,11 @@ Mouse Commands @vindex mouse-wheel-tilt-scroll @vindex mouse-wheel-flip-direction Emacs can also support horizontal scrolling if your mouse's wheel can -be tilted. This feature is off by default; the variable -@code{mouse-wheel-tilt-scroll} turns it on. If you'd like to reverse -the direction of horizontal scrolling, customize the variable -@code{mouse-wheel-flip-direction} to a non-@code{nil} value. +be tilted, or your touchpad supports it. This feature is off by +default; the variable @code{mouse-wheel-tilt-scroll} turns it on. If +you'd like to reverse the direction of horizontal scrolling, customize +the variable @code{mouse-wheel-flip-direction} to a non-@code{nil} +value. =20 When the mouse pointer is over an image, scrolling the mouse wheel with the @key{Ctrl} modifier scales the image under the mouse pointer. diff --git a/lisp/mwheel.el b/lisp/mwheel.el index 56150c803f..41ae3769c1 100644 --- a/lisp/mwheel.el +++ b/lisp/mwheel.el @@ -145,13 +145,16 @@ mouse-wheel-follow-mouse ;;; For tilt-scroll ;;; (defcustom mouse-wheel-tilt-scroll nil - "Enable scroll using tilting mouse wheel." + "Enable horizontal scrolling via mouse or touchpad. +Also see =E2=80=98mouse-wheel-flip-direction=E2=80=99." :group 'mouse :type 'boolean :version "26.1") =20 (defcustom mouse-wheel-flip-direction nil - "Swap direction of `wheel-right' and `wheel-left'." + "Swap direction of `wheel-right' and `wheel-left'. +This inverts the direction of horizontal scrolling. Also see +`mouse-wheel-tilt-scroll'." :group 'mouse :type 'boolean :version "26.1") --=20 2.20.1 --=-=-=--