From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#17716: 24.4.50; doc string of `winner-mode' Date: Fri, 6 Jun 2014 08:08:12 -0700 (PDT) Message-ID: <286670d9-d56d-443d-a802-9000ef817384@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1402067379 25662 80.91.229.3 (6 Jun 2014 15:09:39 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 6 Jun 2014 15:09:39 +0000 (UTC) To: 17716@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jun 06 17:09:31 2014 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Wsvlo-0000Yl-1X for geb-bug-gnu-emacs@m.gmane.org; Fri, 06 Jun 2014 17:09:28 +0200 Original-Received: from localhost ([::1]:47660 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Wsvln-0006gT-Ig for geb-bug-gnu-emacs@m.gmane.org; Fri, 06 Jun 2014 11:09:27 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:57412) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Wsvla-0006XD-1r for bug-gnu-emacs@gnu.org; Fri, 06 Jun 2014 11:09:24 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WsvlP-0005W9-9l for bug-gnu-emacs@gnu.org; Fri, 06 Jun 2014 11:09:13 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:48502) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WsvlP-0005W5-5R for bug-gnu-emacs@gnu.org; Fri, 06 Jun 2014 11:09:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1WsvlO-0005SK-RR for bug-gnu-emacs@gnu.org; Fri, 06 Jun 2014 11:09:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 06 Jun 2014 15:09:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 17716 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.140206733120947 (code B ref -1); Fri, 06 Jun 2014 15:09:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 6 Jun 2014 15:08:51 +0000 Original-Received: from localhost ([127.0.0.1]:47379 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WsvlD-0005Ri-2w for submit@debbugs.gnu.org; Fri, 06 Jun 2014 11:08:51 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:55552) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WsvlA-0005RW-Rx for submit@debbugs.gnu.org; Fri, 06 Jun 2014 11:08:49 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Wsvkv-0005R7-I9 for submit@debbugs.gnu.org; Fri, 06 Jun 2014 11:08:43 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:60654) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Wsvkv-0005Qv-Fy for submit@debbugs.gnu.org; Fri, 06 Jun 2014 11:08:33 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:57163) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Wsvkm-0006Uq-Oe for bug-gnu-emacs@gnu.org; Fri, 06 Jun 2014 11:08:33 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Wsvkd-0005Mn-19 for bug-gnu-emacs@gnu.org; Fri, 06 Jun 2014 11:08:24 -0400 Original-Received: from userp1040.oracle.com ([156.151.31.81]:32728) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Wsvkc-0005Mi-Qc for bug-gnu-emacs@gnu.org; Fri, 06 Jun 2014 11:08:14 -0400 Original-Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id s56F8DF7019857 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Fri, 6 Jun 2014 15:08:14 GMT Original-Received: from aserz7021.oracle.com (aserz7021.oracle.com [141.146.126.230]) by ucsinet22.oracle.com (8.14.5+Sun/8.14.5) with ESMTP id s56F8CHh023605 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Fri, 6 Jun 2014 15:08:13 GMT Original-Received: from abhmp0018.oracle.com (abhmp0018.oracle.com [141.146.116.24]) by aserz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s56F8ChS017760 for ; Fri, 6 Jun 2014 15:08:12 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6691.5000 (x86)] X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.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.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:90131 Archived-At: C'mon. Don't you think there is something wrong with this description of `winner-mode'? Toggle Winner mode on or off. With a prefix argument ARG, enable Winner mode if ARG is positive, and disable it otherwise. If called from Lisp, enable the mode if ARG is omitted or nil, and toggle it if ARG is `toggle'. Substitute `alligator-mode' for `winner-mode' and you get just as much information. It does not even mention "window". This is just the default doc string from `define-minor-mode'. No one has bothered to provide *any* user-helpful description of this mode. Why include a mode in Emacs that cannot even provide a minimal description of itself? If laziness is a prime concern, then just copy the text from the Commentary into the doc string. This library was written in 1997 (!) and has been in Emacs for a while now. It would at least be better to have some of the Commentary in the doc string than to have a doc string that says nothing besides how to turn the mode on. ;;; Commentary: ;; Winner mode is a global minor mode that records the changes in the ;; window configuration (i.e. how the frames are partitioned into ;; windows) so that the changes can be "undone" using the command ;; `winner-undo'. By default this one is bound to the key sequence ;; ctrl-c left. If you change your mind (while undoing), you can ;; press ctrl-c right (calling `winner-redo'). Even though it uses ;; some features of Emacs20.3, winner.el should also work with ;; Emacs19.34 and XEmacs20, provided that the installed version of ;; custom is not obsolete. In GNU Emacs 24.4.50.1 (i686-pc-mingw32) of 2014-06-01 on ODIEONE Bzr revision: 117212 michael.albinus@gmx.de-20140601104945-g88x0mwrxorz302h Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --prefix=3D/c/Devel/emacs/snapshot/trunk --enable-checking=3Dyes,glyphs 'CFLAGS=3D-O0 -g3' LDFLAGS=3D-Lc:/Devel/emacs/lib 'CPPFLAGS=3D-DGC_MCHECK=3D1 -Ic:/Devel/emacs/include''