From: "Göktuğ Kayaalp" <self@gkayaalp.com>
To: martin rudalics <rudalics@gmx.at>
Cc: 39979@debbugs.gnu.org
Subject: bug#39979: 28.0.50; `mouse-wheel-tilt-scroll' docstring is unclear/incomplete
Date: Tue, 10 Mar 2020 19:39:43 +0300 [thread overview]
Message-ID: <ygm8sk8noz4.fsf@gkayaalp.com> (raw)
In-Reply-To: <d33eff76-06ff-cedf-9e40-0e5ad53cc6c4@gmx.at> (message from martin rudalics on Mon, 9 Mar 2020 10:02:35 +0100)
[-- Attachment #1: Type: text/plain, Size: 1585 bytes --]
On 2020-03-09 10:02 +01, martin rudalics <rudalics@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.
[-- Attachment #2: Improved patch --]
[-- Type: text/x-diff, Size: 2363 bytes --]
From 66906d5a680f61528ae1eaee1f101eecebd5a0aa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C4=B0=2E=20G=C3=B6ktu=C4=9F=20Kayaalp?= <self@gkayaalp.com>
Date: Sun, 8 Mar 2020 00:15:01 +0300
Subject: [PATCH] Improve docs for horizontal scrolling with mouse and touchpad
* 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.
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 ‘mouse-wheel-flip-direction’."
:group 'mouse
:type 'boolean
:version "26.1")
(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")
--
2.20.1
next prev parent reply other threads:[~2020-03-10 16:39 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-07 21:25 bug#39979: 28.0.50; `mouse-wheel-tilt-scroll' docstring is unclear/incomplete Göktuğ Kayaalp
2020-03-09 9:02 ` martin rudalics
2020-03-10 16:39 ` Göktuğ Kayaalp [this message]
2020-03-10 17:36 ` Noam Postavsky
2020-03-11 8:52 ` martin rudalics
2020-03-11 13:08 ` Göktuğ Kayaalp
2020-03-11 23:09 ` Tak Kunihiro
2020-03-11 23:52 ` Noam Postavsky
2020-03-12 8:22 ` martin rudalics
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ygm8sk8noz4.fsf@gkayaalp.com \
--to=self@gkayaalp.com \
--cc=39979@debbugs.gnu.org \
--cc=rudalics@gmx.at \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.