From: phillip.lord@newcastle.ac.uk (Phillip Lord)
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: emacs-devel@gnu.org
Subject: Re: Comment conventions, adding an explicit Header.
Date: Fri, 31 Oct 2014 10:02:28 +0000 [thread overview]
Message-ID: <87r3xoo8uj.fsf@newcastle.ac.uk> (raw)
In-Reply-To: <jwvfve58ox8.fsf-monnier+emacs@gnu.org> (Stefan Monnier's message of "Thu, 30 Oct 2014 13:13:58 -0400")
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> Indeed. These will not currently be treated as sections. I could make
>> them so.
>
> That would be good, since that's a common case and it also agrees with
> the official convention (which says that anything that starts with
> "^;;;+ [^ \n]" is a sectioning comment).
>
>> All good feedback. Can I conclude that so far there would be no show
>> stopping problem with adding a ";;; Header:" line where it was wanted?
>
> I must say I don't like the idea of adding ";;; Header:" to every Elisp
> file, no. At least not without a very strong argument for it.
Oh, it doesn't need to be there. I am wondering whether it *can* be
there and iff it is, does it break everything.
Without it, in org-mode you would see this:
----
# # blah.el --- Dull file
This file is not part of Emacs
Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
Other:
GPL Text
* Commentary...
* Code...
----
With it, you get this...
----
# # blah.el -- Dull file
* Header...
* Commentary...
* Code...
----
I think the latter is nicer, that's all.
Phil
next prev parent reply other threads:[~2014-10-31 10:02 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-10-30 10:22 Comment conventions, adding an explicit Header Phillip Lord
2014-10-30 11:59 ` Eric S. Raymond
2014-10-30 12:24 ` Phillip Lord
2014-10-30 12:33 ` Thorsten Jolitz
2014-10-30 13:43 ` Stefan Monnier
2014-10-30 13:58 ` Phillip Lord
2014-10-30 15:36 ` Stefan Monnier
2014-10-30 16:38 ` Phillip Lord
2014-10-30 17:13 ` Stefan Monnier
2014-10-31 10:02 ` Phillip Lord [this message]
2014-10-31 14:07 ` Stefan Monnier
2014-10-31 16:10 ` Phillip Lord
2014-11-01 1:01 ` Stephen J. Turnbull
2014-11-03 10:04 ` Phillip Lord
2014-11-03 11:00 ` Stephen J. Turnbull
2014-11-03 15:22 ` Phillip Lord
2014-10-31 11:50 ` Gregor Zattler
2014-10-31 16:42 ` Phillip Lord
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87r3xoo8uj.fsf@newcastle.ac.uk \
--to=phillip.lord@newcastle.ac.uk \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.