From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: Comment conventions, adding an explicit Header. Date: Thu, 30 Oct 2014 11:36:12 -0400 Message-ID: References: <87d299eu1d.fsf@newcastle.ac.uk> <87a94dd5hi.fsf@newcastle.ac.uk> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1414776117 28659 80.91.229.3 (31 Oct 2014 17:21:57 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 31 Oct 2014 17:21:57 +0000 (UTC) Cc: emacs-devel@gnu.org To: phillip.lord@newcastle.ac.uk (Phillip Lord) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Oct 31 18:21:50 2014 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1XkFtU-0005In-Ku for ged-emacs-devel@m.gmane.org; Fri, 31 Oct 2014 18:21:49 +0100 Original-Received: from localhost ([::1]:39790 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XkFtU-0004bc-6b for ged-emacs-devel@m.gmane.org; Fri, 31 Oct 2014 13:21:48 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50546) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XkEKa-0005TD-Sh for emacs-devel@gnu.org; Fri, 31 Oct 2014 11:43:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Xjrll-00019A-5r for emacs-devel@gnu.org; Thu, 30 Oct 2014 11:36:20 -0400 Original-Received: from pruche.dit.umontreal.ca ([132.204.246.22]:50198) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xjrll-000191-2I for emacs-devel@gnu.org; Thu, 30 Oct 2014 11:36:13 -0400 Original-Received: from ceviche.home (lechon.iro.umontreal.ca [132.204.27.242]) by pruche.dit.umontreal.ca (8.14.1/8.14.1) with ESMTP id s9UFaAVp017506; Thu, 30 Oct 2014 11:36:10 -0400 Original-Received: by ceviche.home (Postfix, from userid 20848) id 6B6A2660F3; Thu, 30 Oct 2014 11:36:12 -0400 (EDT) In-Reply-To: <87a94dd5hi.fsf@newcastle.ac.uk> (Phillip Lord's message of "Thu, 30 Oct 2014 13:58:17 +0000") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.4.50 (gnu/linux) X-NAI-Spam-Flag: NO X-NAI-Spam-Threshold: 5 X-NAI-Spam-Score: 0 X-NAI-Spam-Rules: 1 Rules triggered RV5110=0 X-NAI-Spam-Version: 2.3.0.9393 : core <5110> : inlines <1460> : streams <1330503> : uri <1830457> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 132.204.246.22 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:176098 Archived-At: > True. Currently, I handle the first line specially (as does emacs) > because otherwise you end up with level 1 header with, for example, the > lexical-binding instruction in it. outline-minor-mode doesn't handle it specially. I don't mind having the lexical-binding thingy in there, since it means that when the file "fully folded" I can still immediately know whether the file is using lexical-binding or not. > Also, in the org-mode transformation I translate this into a org-mode > comment. The reason for this is that org-mode also has a "start of file" > semantics -- the lines before the first header is special. Not knowing what this "special" implies, it's hard to judge whether it's important. > Also, all the other headers that I see ("Commentary", "Status", "Code" > and so forth) are single word and end with an ":". So, currently, I use > this semantics also. The few files that use ";;;" for sectioning *within* the code itself don't seem to use "single word with a colon" very much. E.g. a quick grep shows things like: lisp/wid-edit.el:;;; Utility functions. lisp/wid-edit.el:;;; Widget text specifications. lisp/wid-edit.el:;;; Widget Properties. lisp/view.el:;;; Commands that enter or exit view mode. lisp/view.el:;;; Some help routines. lisp/view.el:;;; Commands for moving around in the buffer. lisp/vc/ediff-util.el:;;; Build keymaps lisp/vc/ediff-util.el:;;; Setup functions lisp/vc/ediff-util.el:;;; Commands for working with Ediff lisp/vc/ediff-util.el:;;; Copying diffs. Stefan