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

Previous Next

Package: emacs;

Reported by: Göktuğ Kayaalp <self <at> gkayaalp.com>

Date: Sat, 7 Mar 2020 21:27:02 UTC

Severity: normal

Tags: fixed

Found in version 28.0.50

Fixed in version 27.1

Done: Noam Postavsky <npostavs <at> gmail.com>

Bug is archived. No further changes may be made.

Full log

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

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

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

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?

martin
This bug report was last modified 5 years and 74 days ago.

Previous Next

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