From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Ilya Zakharevich Newsgroups: gmane.emacs.bugs Subject: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file Date: Sat, 21 Feb 2009 14:53:49 -0800 Message-ID: <20090221225349.GA10921@powdermilk.math.berkeley.edu> References: <1235155177.28052.1301523467@webmail.messagingengine.com> <20090221001534.GA5340@powdermilk.math.berkeley.edu> <1235213681.789.1301613957@webmail.messagingengine.com> Reply-To: Ilya Zakharevich , 1621@emacsbugs.donarmstrong.com NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: ger.gmane.org 1235257492 16182 80.91.229.12 (21 Feb 2009 23:04:52 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 21 Feb 2009 23:04:52 +0000 (UTC) Cc: 1621@emacsbugs.donarmstrong.com To: era eriksson Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Feb 22 00:06:08 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 1Lb0ue-00025j-MI for geb-bug-gnu-emacs@m.gmane.org; Sun, 22 Feb 2009 00:05:53 +0100 Original-Received: from localhost ([127.0.0.1]:37282 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Lb0tK-0002S5-7d for geb-bug-gnu-emacs@m.gmane.org; Sat, 21 Feb 2009 18:04:14 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Lb0sn-0002G5-Nf for bug-gnu-emacs@gnu.org; Sat, 21 Feb 2009 18:03:41 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1Lb0sm-0002FT-2f for bug-gnu-emacs@gnu.org; Sat, 21 Feb 2009 18:03:40 -0500 Original-Received: from [199.232.76.173] (port=46347 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Lb0sl-0002FH-Kt for bug-gnu-emacs@gnu.org; Sat, 21 Feb 2009 18:03:39 -0500 Original-Received: from rzlab.ucr.edu ([138.23.92.77]:35096) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1Lb0sk-0006Cb-RH for bug-gnu-emacs@gnu.org; Sat, 21 Feb 2009 18:03:39 -0500 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 n1LN3a0G021557; Sat, 21 Feb 2009 15:03:36 -0800 Original-Received: (from debbugs@localhost) by rzlab.ucr.edu (8.13.8/8.13.8/Submit) id n1LN04UC020457; Sat, 21 Feb 2009 15:00:04 -0800 X-Loop: owner@emacsbugs.donarmstrong.com Resent-From: Ilya Zakharevich Resent-To: bug-submit-list@donarmstrong.com Resent-CC: Emacs Bugs Resent-Date: Sat, 21 Feb 2009 23:00:04 +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.123525683319078 (code B ref 1621); Sat, 21 Feb 2009 23:00:04 +0000 Original-Received: (at 1621) by emacsbugs.donarmstrong.com; 21 Feb 2009 22:53:53 +0000 X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. Original-Received: from mail.math.berkeley.edu (mail.math.Berkeley.EDU [169.229.58.57]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id n1LMrpw1019072 for <1621@emacsbugs.donarmstrong.com>; Sat, 21 Feb 2009 14:53:52 -0800 Original-Received: from powdermilk.math.berkeley.edu (IDENT:5930@powdermilk.Math.Berkeley.EDU [169.229.140.13]) by mail.math.berkeley.edu (8.14.3/8.14.3) with ESMTP id n1LMroXK079288; Sat, 21 Feb 2009 14:53:50 -0800 (PST) (envelope-from ilya@mail.math.berkeley.edu) Original-Received: (from ilya@localhost) by powdermilk.math.berkeley.edu (8.13.8+Sun/8.12.10/Submit) id n1LMroOu010934; Sat, 21 Feb 2009 14:53:50 -0800 (PST) Content-Disposition: inline In-Reply-To: <1235213681.789.1301613957@webmail.messagingengine.com> User-Agent: mutt-ng/devel-r561 (SunOS) X-Scanned-By: MIMEDefang 2.64 on 169.229.58.57 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 3) Resent-Date: Sat, 21 Feb 2009 18:03:40 -0500 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:25570 Archived-At: 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. Oups, did not realize this; sorry! I agree; >> TODO. Thanks, Ilya 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... ;-)