From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "era eriksson" Newsgroups: gmane.emacs.bugs Subject: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file Date: Mon, 16 Mar 2009 04:10:57 +0200 Message-ID: <1237169457.11425.1305561241@webmail.messagingengine.com> References: <1235155177.28052.1301523467@webmail.messagingengine.com> <20090221001534.GA5340@powdermilk.math.berkeley.edu> <1235213681.789.1301613957@webmail.messagingengine.com> <20090221225349.GA10921@powdermilk.math.berkeley.edu> Reply-To: era eriksson , 1621@emacsbugs.donarmstrong.com NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="ISO-8859-15" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1237170252 22255 80.91.229.12 (16 Mar 2009 02:24:12 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 16 Mar 2009 02:24:12 +0000 (UTC) Cc: 1621@emacsbugs.donarmstrong.com To: "Ilya Zakharevich" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Mar 16 03:25:28 2009 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1Lj2W6-00072f-Q0 for geb-bug-gnu-emacs@m.gmane.org; Mon, 16 Mar 2009 03:25:27 +0100 Original-Received: from localhost ([127.0.0.1]:54117 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Lj2Uk-0003Q1-Jh for geb-bug-gnu-emacs@m.gmane.org; Sun, 15 Mar 2009 22:24:02 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Lj2UY-0003Md-BZ for bug-gnu-emacs@gnu.org; Sun, 15 Mar 2009 22:23:50 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1Lj2UT-0003Lc-8G for bug-gnu-emacs@gnu.org; Sun, 15 Mar 2009 22:23:49 -0400 Original-Received: from [199.232.76.173] (port=44477 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Lj2UT-0003LS-2J for bug-gnu-emacs@gnu.org; Sun, 15 Mar 2009 22:23:45 -0400 Original-Received: from rzlab.ucr.edu ([138.23.92.77]:41338) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1Lj2US-0005Px-Jj for bug-gnu-emacs@gnu.org; Sun, 15 Mar 2009 22:23:44 -0400 Original-Received: from rzlab.ucr.edu (rzlab.ucr.edu [127.0.0.1]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id n2G2Ngmc015253; Sun, 15 Mar 2009 19:23:42 -0700 Original-Received: (from debbugs@localhost) by rzlab.ucr.edu (8.13.8/8.13.8/Submit) id n2G2F3LU012817; Sun, 15 Mar 2009 19:15:03 -0700 X-Loop: owner@emacsbugs.donarmstrong.com Resent-From: "era eriksson" Resent-To: bug-submit-list@donarmstrong.com Resent-CC: Emacs Bugs Resent-Date: Mon, 16 Mar 2009 02:15:03 +0000 Resent-Message-ID: Resent-Sender: owner@emacsbugs.donarmstrong.com X-Emacs-PR-Message: followup 1621 X-Emacs-PR-Package: emacs X-Emacs-PR-Keywords: wontfix Original-Received: via spool by 1621-submit@emacsbugs.donarmstrong.com id=B1621.123716946212638 (code B ref 1621); Mon, 16 Mar 2009 02:15:03 +0000 Original-Received: (at 1621) by emacsbugs.donarmstrong.com; 16 Mar 2009 02:11:02 +0000 X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. Original-Received: from out1.smtp.messagingengine.com (out1.smtp.messagingengine.com [66.111.4.25]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id n2G2AwfD012631 for <1621@emacsbugs.donarmstrong.com>; Sun, 15 Mar 2009 19:11:00 -0700 Original-Received: from compute1.internal (compute1.internal [10.202.2.41]) by out1.messagingengine.com (Postfix) with ESMTP id A546F2EE55C; Sun, 15 Mar 2009 22:10:57 -0400 (EDT) Original-Received: from web6.messagingengine.com ([10.202.2.215]) by compute1.internal (MEProxy); Sun, 15 Mar 2009 22:10:57 -0400 Original-Received: by web6.messagingengine.com (Postfix, from userid 99) id 85B4E37BD1; Sun, 15 Mar 2009 22:10:57 -0400 (EDT) X-Sasl-Enc: c6IKq28C1lTXP0DEM9zKyRgRkvae749+TC6rDd2M9Vmb 1237169457 Content-Disposition: inline X-Mailer: MessagingEngine.com Webmail Interface In-Reply-To: <20090221225349.GA10921@powdermilk.math.berkeley.edu> X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 3) Resent-Date: Sun, 15 Mar 2009 22:23:49 -0400 X-BeenThere: bug-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:26378 Archived-At: On Sat, 21 Feb 2009 14:53:49 -0800, "Ilya Zakharevich" said: > On Sat, Feb 21, 2009 at 12:54:41PM +0200, era eriksson wrote: > > > > Please find attached a proposed patch. This is just a quick > > > > proof of concept; perhaps there is more startup-related > > > > information which could be moved to the new variable. > > > > > > Again, I see no point in moving this information from the mode > > > help. Why would one think it is an improvement? > > > > This information is currently not in the mode help proper at all. I > > thought that this was by design. I agree that moving it to the > > `cperl-mode' documentation string from the `cperl-tips' > > documentation would already be an improvement. <...> > P.S. > > > Breaking out the setup / invocation information into its own clearly > > labelled micro-doc would have the benefit of making it easy to > > refer to it directly from e.g. the Commentary (as requested by the > > original reporter) and other places (Info, Customize, etc) and > > separating it into one coherent, rather short topic for those who > > are only looking for this specific information. The `cperl-tips' > > "micro-doc" has a rather oblique label and covers a lot of > > different topics, making it rather long, in spite of the "micro". > > I expect that most people would explore Micro-docs from the mode menu. > So putting this info there would be chicken-and-egg problem: to access > the info on enabling the mode, they would need to enable the mode. > > If this info is clearly visible in the mode help, do you think it > still makes sense to duplicate it in the micro-docs? Like > > What is this mode you are using? I did not see it before... How to > enable it? Oh, it has a mode menu... > > ;-) Sorry for this late reply; missed your PS originally. I do think it makes sense to keep it in the micro-docs. If nothing else, it's easy to refer newcomers to it, and even if you did manage to somehow set it up on your own, you might want to review the "official" way to do it, perhaps while idly browsing the micro-docs looking for neat stuff you didn't originally understand how to set up. Another thing I've been meaning to propose would be for cperl-mode to offer to install itself into your .emacs when you invoke it for the first time, sort of like how (put 'dangerous-command 'disabled nil) occasionally gets added to your .emacs after asking for permission. (IIRC narrow-to-region is one of these "dangerous" commands, and some of the horizontal scrolling commands which I never use except by mistake.) Do you think it would be appropriate to remove the +wontfix tag from this bug? (Not sure whether or not this bug applies to upstream Emacs or your code at this point, and how the two are being coordinated, if at all.) /* era */ -- If this were a real .signature, it would suck less. Well, maybe not.