emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Comment conventions, adding an explicit Header.


From: Phillip Lord
Subject: Re: Comment conventions, adding an explicit Header.
Date: Fri, 31 Oct 2014 10:02:28 +0000
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3 (gnu/linux)

Stefan Monnier <address@hidden> 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 <address@hidden>
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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]