GNU bug report logs - #1621
Please move cperl micro-docs to top of the cperl-mode.el file

Previous Next

Package: emacs;

Reported by: "Jason A. Spiro" <jasonspiro4 <at> gmail.com>

Date: Thu, 18 Dec 2008 05:20:03 UTC

Severity: wishlist

Tags: fixed

Fixed in version 28.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

Forwarded to eye.el.why.aye.zee@cee.pee.aye.en.dot.org.invalid

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 1621 in the body.
You can then email your comments to 1621 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Thu, 18 Dec 2008 05:20:04 GMT) Full text and rfc822 format available.

Acknowledgement sent to "Jason A. Spiro" <jasonspiro4 <at> gmail.com>:
New bug report received and forwarded. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Thu, 18 Dec 2008 05:20:04 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Jason A. Spiro" <jasonspiro4 <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Thu, 18 Dec 2008 00:14:25 -0500
Package: emacs
Severity: wishlist

Feature request forwarded from https://launchpad.net/bugs/99634 :

---------- Forwarded message ----------
From: Jason Spiro <jasonspiro3 <at> gmail.com>
Date: 2007/3/31
Subject: [Bug 99634] Please move cperl micro-docs to top of the
cperl-mode.el file
To: jasonspiro3 <at> gmail.com


Public bug reported:

Binary package hint: emacs-snapshot

I wanted to set Emacs to use cperl-mode instead of perl-mode, but I
didn't know how.  It turns out the answer was in the cperl-tips section
on line 710 of the file.

Please move the cperl micro-docs from the middle of the cperl-mode.el
Elisp file to the top of the file.  This will make more people see them.





Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Thu, 18 Dec 2008 21:40:11 GMT) Full text and rfc822 format available.

Acknowledgement sent to Stefan Monnier <monnier <at> iro.umontreal.ca>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Thu, 18 Dec 2008 21:40:11 GMT) Full text and rfc822 format available.

Message #10 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: "Jason A. Spiro" <jasonspiro4 <at> gmail.com>
Cc: 1621 <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Thu, 18 Dec 2008 16:39:40 -0500
> Please move the cperl micro-docs from the middle of the cperl-mode.el
> Elisp file to the top of the file.  This will make more people see them.

I suggest we add some text in the Commentary that point people to the
docstrings below.  Moving the docstrings wholesale will increase the
merge burden when syncing with Ilya's version.


        Stefan





Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Thu, 18 Dec 2008 21:40:12 GMT) Full text and rfc822 format available.

Acknowledgement sent to Stefan Monnier <monnier <at> iro.umontreal.ca>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Thu, 18 Dec 2008 21:40:12 GMT) Full text and rfc822 format available.

Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Fri, 19 Dec 2008 02:35:03 GMT) Full text and rfc822 format available.

Message #18 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 1621 <at> debbugs.gnu.org, "Jason A. Spiro" <jasonspiro4 <at> gmail.com>
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Thu, 18 Dec 2008 21:28:22 -0500
tags 1621 wontfix
stop

Stefan Monnier wrote:

>> Please move the cperl micro-docs from the middle of the cperl-mode.el
>> Elisp file to the top of the file.  This will make more people see them.
>
> I suggest we add some text in the Commentary that point people to the
> docstrings below.

There already is such text, indicated with capital letters and "<<<<<"
signs, no less.




Tags added: wontfix Request was from Glenn Morris <rgm <at> gnu.org> to control <at> emacsbugs.donarmstrong.com. (Fri, 19 Dec 2008 02:35:07 GMT) Full text and rfc822 format available.

Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Fri, 19 Dec 2008 09:20:03 GMT) Full text and rfc822 format available.

Acknowledgement sent to "Jason A. Spiro" <jasonspiro4 <at> gmail.com>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Fri, 19 Dec 2008 09:20:03 GMT) Full text and rfc822 format available.

Message #25 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Jason A. Spiro" <jasonspiro4 <at> gmail.com>
To: cpan <at> ilyaz.org
Cc: 1621 <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org,
        "Stefan Monnier" <monnier <at> iro.umontreal.ca>
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Fri, 19 Dec 2008 01:06:44 -0500
2008/12/18 Stefan Monnier <monnier <at> iro.umontreal.ca> wrote:
>> Please move the cperl micro-docs from the middle of the cperl-mode.el
>> Elisp file to the top of the file.  This will make more people see them.
>
> I suggest we add some text in the Commentary that point people to the
> docstrings below.  Moving the docstrings wholesale will increase the
> merge burden when syncing with Ilya's version.

Ilya, could you too please move the micro-docs from the middle of the
your cperl-mode.el Elisp file to the top of the file?  This will make
more people see the micro-docs.  And then I hope the GNU Emacs
maintainers will adopt your change downstream.

Please Reply to All.  By the way, I sent mail to this address
@ilyaz.org because I could not find any non-Perl-related address to
write to.

-- 
Jason Spiro: software/web developer, packager, trainer, IT consultant.
I support Linux, UNIX, Windows, and more. Contact me to discuss your needs.
+1 (416) 992-3445 / www.jspiro.com




Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Fri, 19 Dec 2008 09:20:06 GMT) Full text and rfc822 format available.

Acknowledgement sent to "Jason A. Spiro" <jasonspiro4 <at> gmail.com>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Fri, 19 Dec 2008 09:20:06 GMT) Full text and rfc822 format available.

Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Sat, 20 Dec 2008 23:00:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Sat, 20 Dec 2008 23:00:03 GMT) Full text and rfc822 format available.

Message #35 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>
To: "Jason A. Spiro" <jasonspiro4 <at> gmail.com>
Cc: 1621 <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org,
        Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Sat, 20 Dec 2008 14:53:09 -0800
On Fri, Dec 19, 2008 at 01:06:44AM -0500, Jason A. Spiro wrote:
> Ilya, could you too please move the micro-docs from the middle of the
> your cperl-mode.el Elisp file to the top of the file?  This will make
> more people see the micro-docs.

Could you please explain to me the mental model of people who would
read the code of CPerl, but not the mode help, and would not explore
the mode menu?

Thanks,
Ilya





Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Sat, 20 Dec 2008 23:00:04 GMT) Full text and rfc822 format available.

Acknowledgement sent to Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Sat, 20 Dec 2008 23:00:04 GMT) Full text and rfc822 format available.

Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Sat, 20 Dec 2008 23:50:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to "Jason A. Spiro" <jasonspiro4 <at> gmail.com>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Sat, 20 Dec 2008 23:50:03 GMT) Full text and rfc822 format available.

Message #45 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Jason A. Spiro" <jasonspiro4 <at> gmail.com>
To: "Ilya Zakharevich" <ilya <at> math.berkeley.edu>
Cc: 1621 <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org,
        "Stefan Monnier" <monnier <at> iro.umontreal.ca>
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Sat, 20 Dec 2008 18:41:36 -0500
2008/12/20 Ilya Zakharevich <ilya <at> math.berkeley.edu>:
> Could you please explain to me the mental model of people who would
> read the code of CPerl, but not the mode help, and would not explore
> the mode menu?

I don't know why that mental model has happened.  But I know it
happened to me.  I don't expect help to be located halfway through a
Lisp file.  I expect it to be either in Info format or as docstrings
or near the top of the file.  :)

Remember, the change I am suggesting is an easy one to make.





Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Sat, 20 Dec 2008 23:50:04 GMT) Full text and rfc822 format available.

Acknowledgement sent to "Jason A. Spiro" <jasonspiro4 <at> gmail.com>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Sat, 20 Dec 2008 23:50:04 GMT) Full text and rfc822 format available.

Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Sun, 21 Dec 2008 00:20:03 GMT) Full text and rfc822 format available.

Acknowledgement sent to "Jason A. Spiro" <jasonspiro4 <at> gmail.com>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Sun, 21 Dec 2008 00:20:03 GMT) Full text and rfc822 format available.

Message #55 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Jason A. Spiro" <jasonspiro4 <at> gmail.com>
To: "Ilya Zakharevich" <ilya <at> math.berkeley.edu>
Cc: 1621 <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org,
        "Stefan Monnier" <monnier <at> iro.umontreal.ca>
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Sat, 20 Dec 2008 19:13:50 -0500
2008/12/20 Ilya Zakharevich <ilya <at> math.berkeley.edu> wrote:
>
> Let me STILL try to get some clarification.  Did you not read the mode
> help, and/or investigated the mode menu, or you did but not noticed
> references to micro-docs?

IIRC I did not read the mode help or look at the mode menu.  I simply
looked for a Commentary section.

I hadn't used the mode much yet:  it definitely had been less than an
hour.  But in general, I almost never read mode help, and I seldom
look at mode menus.  I do sometimes read mode Info documentation, or
Lisp file Commentary sections.

P.S.  I added the original CC list back.  If you did not want me to do
this, please let me know.





Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Sun, 21 Dec 2008 00:20:05 GMT) Full text and rfc822 format available.

Acknowledgement sent to "Jason A. Spiro" <jasonspiro4 <at> gmail.com>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Sun, 21 Dec 2008 00:20:05 GMT) Full text and rfc822 format available.

Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Fri, 20 Feb 2009 18:45:03 GMT) Full text and rfc822 format available.

Acknowledgement sent to "era eriksson" <era <at> iki.fi>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Fri, 20 Feb 2009 18:45:03 GMT) Full text and rfc822 format available.

Message #65 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "era eriksson" <era <at> iki.fi>
To: 1621 <at> debbugs.gnu.org
Cc: "Ilya Zakharevich" <ilya <at> Math.Berkeley.EDU>
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el
 file
Date: Fri, 20 Feb 2009 20:39:37 +0200
[Message part 1 (text/plain, inline)]
How about a slight refactoring to make it more obvious where to look for
the startup information?

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.

(Cc:ing Ilya as I don't know whether he subscribes to this bug report.)

/* era */

-- 
If this were a real .signature, it would suck less.  Well, maybe not.

[cperl-mode-el.patch (text/x-patch, attachment)]

Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Sat, 21 Feb 2009 00:25:05 GMT) Full text and rfc822 format available.

Acknowledgement sent to Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Sat, 21 Feb 2009 00:25:05 GMT) Full text and rfc822 format available.

Message #70 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>
To: era eriksson <era <at> iki.fi>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Fri, 20 Feb 2009 16:15:34 -0800
On Fri, Feb 20, 2009 at 08:39:37PM +0200, era eriksson wrote:
> How about a slight refactoring to make it more obvious where to look for
> the startup information?
> 
> 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?

Yours,
Ilya




Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Sat, 21 Feb 2009 11:00:03 GMT) Full text and rfc822 format available.

Acknowledgement sent to "era eriksson" <era <at> iki.fi>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Sat, 21 Feb 2009 11:00:03 GMT) Full text and rfc822 format available.

Message #75 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "era eriksson" <era <at> iki.fi>
To: "Ilya Zakharevich" <ilya <at> Math.Berkeley.EDU>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el
 file
Date: Sat, 21 Feb 2009 12:54:41 +0200
On Fri, 20 Feb 2009 16:15:34 -0800, "Ilya Zakharevich"
<ilya <at> Math.Berkeley.EDU> said:
> On Fri, Feb 20, 2009 at 08:39:37PM +0200, era eriksson wrote:
> > How about a slight refactoring to make it more obvious where to 
> > look for the startup information?
> > 
> > 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.

The name of `cperl-tips' I think suggests that it explains how to use
some slightly esoteric features, and by and large this holds true.  I
have been looking for the startup information on numerous occasions, and
more often than not ignored `cperl-tips' based on my interpretation of
what the name means.

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

Especially for a feature which is likely to be the first and possibly
only time a new user tries to get to know cperl-mode, usability is of
critical importance.  If it's not blindingly obvious how to enable
cperl-mode by default, many potential users will simply give up on it.

/* era */

-- 
If this were a real .signature, it would suck less.  Well, maybe not.





Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Sat, 21 Feb 2009 23:00:04 GMT) Full text and rfc822 format available.

Acknowledgement sent to Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Sat, 21 Feb 2009 23:00:04 GMT) Full text and rfc822 format available.

Message #80 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>
To: era eriksson <era <at> iki.fi>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Sat, 21 Feb 2009 14:53:49 -0800
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...

;-)




Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Mon, 16 Mar 2009 02:15:03 GMT) Full text and rfc822 format available.

Acknowledgement sent to "era eriksson" <era <at> iki.fi>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Mon, 16 Mar 2009 02:15:03 GMT) Full text and rfc822 format available.

Message #85 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "era eriksson" <era <at> iki.fi>
To: "Ilya Zakharevich" <ilya <at> Math.Berkeley.EDU>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el
 file
Date: Mon, 16 Mar 2009 04:10:57 +0200
On Sat, 21 Feb 2009 14:53:49 -0800, "Ilya Zakharevich"
<ilya <at> Math.Berkeley.EDU> 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.





Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Mon, 16 Mar 2009 04:10:04 GMT) Full text and rfc822 format available.

Acknowledgement sent to Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Mon, 16 Mar 2009 04:10:04 GMT) Full text and rfc822 format available.

Message #90 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>
To: era eriksson <era <at> iki.fi>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Sun, 15 Mar 2009 21:03:14 -0700
On Mon, Mar 16, 2009 at 04:10:57AM +0200, era eriksson wrote:
> 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.)

Myself, I would hate it if it were like this: supposed I'm annoyed by
this "feature" - should it also ask whether to put a command into
.emacs which would disable this question?  ;-)

> Do you think it would be appropriate to remove the +wontfix tag from
> this bug?

I do not know what "the +wontfix" means.  The situation is as in "I
considered your suggestions, I appreciated your suggestions, and I
even mentioned possibly reconsidering your suggestions in my TODO
files".  ;-)

Yours,
Ilya




Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Mon, 16 Mar 2009 08:55:05 GMT) Full text and rfc822 format available.

Acknowledgement sent to "era eriksson" <era <at> iki.fi>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Mon, 16 Mar 2009 08:55:05 GMT) Full text and rfc822 format available.

Message #95 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "era eriksson" <era <at> iki.fi>
To: "Ilya Zakharevich" <ilya <at> Math.Berkeley.EDU>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el
 file
Date: Mon, 16 Mar 2009 10:48:40 +0200
On Sun, 15 Mar 2009 21:03:14 -0700, "Ilya Zakharevich"
<ilya <at> Math.Berkeley.EDU> said:
> On Mon, Mar 16, 2009 at 04:10:57AM +0200, era eriksson wrote:
> > 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.)
> 
> Myself, I would hate it if it were like this: supposed I'm annoyed by
> this "feature" - should it also ask whether to put a command into
> .emacs which would disable this question?  ;-)

The 'disabled logic is fairly unobtrusive IMHO.  My suggestion would be
to (defvar 'cperl-mode-install-setup-flag 'ask) and then either add
(setq 'cperl-mode-install-setup-flag nil) or 't to the user's .emacs if
the user doesn't specifically select "continue to ask me" instead of
"yes" or "no".

The main logic would simply inspect the value during load and do or do
not (there is no try :-) depending on what it says.

To my uneducated $self this sounds like it would need to go in a
separate .el file which would have some sort of ;;;###autoload but maybe
there is a more elegant way.

> > Do you think it would be appropriate to remove the +wontfix tag from
> > this bug?
> 
> I do not know what "the +wontfix" means.  The situation is as in "I
> considered your suggestions, I appreciated your suggestions, and I
> even mentioned possibly reconsidering your suggestions in my TODO
> files".  ;-)

I'm talking about the bug's status in the Emacs Bug Tracking System at
http://debbugs.gnu.org/1621 -- if Emacs maintainers don't
object, I'll change it to "forwarded <ilya <at> Math.Berkeley.EDU>" and take
away the wontfix tag.  I hope it's not too far of a stretch to interpret
your answer to mean that you don't really care about the Emacs BTS
status of this bug report.

(The bug tracking system is an installation of the Debian BTS which by
design doesn't ever obfuscate email addresses.  I really hate this
"feature" because it's a regular fly paper for spam.  Maybe you would
prefer if I put something else than your email address in the
"forwarded" field, although I guess by and large the damage is already
done.)

/* era */

-- 
If this were a real .signature, it would suck less.  Well, maybe not.





Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Mon, 16 Mar 2009 09:20:03 GMT) Full text and rfc822 format available.

Acknowledgement sent to Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Mon, 16 Mar 2009 09:20:04 GMT) Full text and rfc822 format available.

Message #100 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Ilya Zakharevich <ilya <at> Math.Berkeley.EDU>
To: era eriksson <era <at> iki.fi>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Mon, 16 Mar 2009 02:12:05 -0700
On Mon, Mar 16, 2009 at 10:48:40AM +0200, era eriksson wrote:
> I'm talking about the bug's status in the Emacs Bug Tracking System at
> http://emacsbugs.donarmstrong.com/1621 -- if Emacs maintainers don't
> object, I'll change it to "forwarded <ilya <at> Math.Berkeley.EDU>" and take
> away the wontfix tag.  I hope it's not too far of a stretch to interpret
> your answer to mean that you don't really care about the Emacs BTS
> status of this bug report.
> 
> (The bug tracking system is an installation of the Debian BTS which by
> design doesn't ever obfuscate email addresses.  I really hate this
> "feature" because it's a regular fly paper for spam.  Maybe you would
> prefer if I put something else than your email address in the
> "forwarded" field, although I guess by and large the damage is already
> done.)

Thanks, Era, I would prefer obfuscation, and not of berkeley address,
but of ilyaz <at> cpan.org...

Yours,
Ilya




Tags removed: wontfix Request was from "era eriksson" <era <at> iki.fi> to control <at> emacsbugs.donarmstrong.com. (Mon, 16 Mar 2009 19:55:05 GMT) Full text and rfc822 format available.

Noted your statement that bug has been forwarded to eye.el.why.aye.zee <at> cee.pee.aye.en.dot.org.invalid. Request was from "era eriksson" <era <at> iki.fi> to control <at> emacsbugs.donarmstrong.com. (Mon, 16 Mar 2009 19:55:06 GMT) Full text and rfc822 format available.

Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Mon, 16 Mar 2009 20:10:05 GMT) Full text and rfc822 format available.

Acknowledgement sent to "era eriksson" <era <at> iki.fi>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Mon, 16 Mar 2009 20:10:05 GMT) Full text and rfc822 format available.

Message #109 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "era eriksson" <era <at> iki.fi>
To: "Ilya Zakharevich" <ilya <at> Math.Berkeley.EDU>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el
 file
Date: Mon, 16 Mar 2009 22:00:31 +0200
On Mon, 16 Mar 2009 02:12:05 -0700, "Ilya Zakharevich"
<ilya <at> Math.Berkeley.EDU> said:
> On Mon, Mar 16, 2009 at 10:48:40AM +0200, era eriksson wrote:
> > I'm talking about the bug's status in the Emacs Bug Tracking System at
> > http://emacsbugs.donarmstrong.com/1621 -- if Emacs maintainers don't
> > object, I'll change it to "forwarded <ilya <at> Math.Berkeley.EDU>" and 
> > take away the wontfix tag.  I hope it's not too far of a stretch to 
> > interpret your answer to mean that you don't really care about the 
> > Emacs BTS status of this bug report.
> > 
> > (The bug tracking system is an installation of the Debian BTS which by
> > design doesn't ever obfuscate email addresses.  I really hate this
> > "feature" because it's a regular fly paper for spam.  Maybe you would
> > prefer if I put something else than your email address in the
> > "forwarded" field, although I guess by and large the damage is already
> > done.)
> 
> Thanks, Era, I would prefer obfuscation, and not of berkeley address,
> but of ilyaz <at> cpan.org...

Done now, but you should be aware that the whole conversation is being
archived at the URL quoted above, in mbox format and various other
renderings.  I apologize if this was not sufficiently clear earlier. 
(It's the Cc: which does it.)

/* era */

-- 
If this were a real .signature, it would suck less.  Well, maybe not.





Information forwarded to bug-submit-list <at> lists.donarmstrong.com, Emacs Bugs <bug-gnu-emacs <at> gnu.org>:
bug#1621; Package emacs. (Tue, 17 Mar 2009 00:00:03 GMT) Full text and rfc822 format available.

Acknowledgement sent to Ilya Zakharevich <nospam-abuse <at> ilyaz.org>:
Extra info received and forwarded to list. Copy sent to Emacs Bugs <bug-gnu-emacs <at> gnu.org>. (Tue, 17 Mar 2009 00:00:03 GMT) Full text and rfc822 format available.

Message #114 received at 1621 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Ilya Zakharevich <nospam-abuse <at> ilyaz.org>
To: era eriksson <era <at> iki.fi>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the cperl-mode.el file
Date: Mon, 16 Mar 2009 16:50:30 -0700
On Mon, Mar 16, 2009 at 10:00:31PM +0200, era eriksson wrote:
> > Thanks, Era, I would prefer obfuscation, and not of berkeley address,
> > but of ilyaz <at> cpan.org...
> 
> Done now, but you should be aware that the whole conversation is being
> archived at the URL quoted above, in mbox format and various other
> renderings.  I apologize if this was not sufficiently clear earlier. 
> (It's the Cc: which does it.)

Oups!  And I wondered why spam started to arrive directly to berkeley
address...  The major problem is that this Cc-address does not follow
the conventions for maillist addresses.  (My emailing setup tries to
recognize mailing lists, and uses a "logical" From-address in such
cases.  I reconfigured it now; checking....  Yes, it does recognize
this Cc address as a mailing list now...)

Thanks,
Ilya




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#1621; Package emacs. (Thu, 15 Oct 2020 15:12:01 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Jason A. Spiro" <jasonspiro4 <at> gmail.com>
Cc: 1621 <at> debbugs.gnu.org
Subject: Re: bug#1621: Please move cperl micro-docs to top of the
 cperl-mode.el file
Date: Thu, 15 Oct 2020 17:11:29 +0200
"Jason A. Spiro" <jasonspiro4 <at> gmail.com> writes:

> I wanted to set Emacs to use cperl-mode instead of perl-mode, but I
> didn't know how.  It turns out the answer was in the cperl-tips section
> on line 710 of the file.

I've now added a more explicit reference in the comments in cperl-mode
as to where to find the microdocs in Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Added tag(s) fixed. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Thu, 15 Oct 2020 15:12:02 GMT) Full text and rfc822 format available.

bug marked as fixed in version 28.1, send any further explanations to 1621 <at> debbugs.gnu.org and "Jason A. Spiro" <jasonspiro4 <at> gmail.com> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Thu, 15 Oct 2020 15:12:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Fri, 13 Nov 2020 12:24:08 GMT) Full text and rfc822 format available.

This bug report was last modified 3 years and 155 days ago.

Previous Next


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