From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Barry OReilly Newsgroups: gmane.emacs.devel Subject: Re: Modern Conventions for Emacs Lisp files? Date: Tue, 9 Apr 2013 10:00:56 -0400 Message-ID: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=001a11c21d1a7fc4a304d9edfb2b X-Trace: ger.gmane.org 1365516104 14746 80.91.229.3 (9 Apr 2013 14:01:44 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 9 Apr 2013 14:01:44 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Apr 09 16:01:48 2013 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 1UPZ7L-0003Du-Lx for ged-emacs-devel@m.gmane.org; Tue, 09 Apr 2013 16:01:47 +0200 Original-Received: from localhost ([::1]:56444 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UPZ7L-00081n-20 for ged-emacs-devel@m.gmane.org; Tue, 09 Apr 2013 10:01:47 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:51669) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UPZ6Z-00071S-OF for emacs-devel@gnu.org; Tue, 09 Apr 2013 10:01:00 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UPZ6Y-0005Ox-Dy for emacs-devel@gnu.org; Tue, 09 Apr 2013 10:00:59 -0400 Original-Received: from mail-ob0-x232.google.com ([2607:f8b0:4003:c01::232]:43562) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UPZ6X-0005Ol-WC for emacs-devel@gnu.org; Tue, 09 Apr 2013 10:00:58 -0400 Original-Received: by mail-ob0-f178.google.com with SMTP id ni5so2394084obc.37 for ; Tue, 09 Apr 2013 07:00:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:x-received:date:message-id:subject:from:to :content-type; bh=xmCz0GxqGSX35dwYAg+XeNTy5knwChL4o9MOUcHXg1o=; b=u0VCYOCLP0SzpKSecHbWoPLfy6EzcVjz+mdS1RSYWitLz7dR0fsBOuYLzHcDfGsLaH sUhi7Cpf7UVyCRxekzunJNFrc/jC991ONoyqwSVDX0m7iwmiWP9fGQpb8Q+ao+WrMShA 7/j2OkErgkTHU3rKDu6TQXVZvwLGB2CCt/8RiJi9uNHynYKOJ2h/s/0d0ZobuVHt2IlP 68eEfrCKAcfUBHIadTt5j1qItG6A2hHvQKTq+3wUih45x9NJ0WOZjZ6W1ETri7ujBbju yd7udXk5QHDzYcOIyI+UiYvtnynhOt+GlmCQr4M/47L0ei8Hc31X96mfLG4iduweodr4 SzEw== X-Received: by 10.60.63.73 with SMTP id e9mr18337424oes.87.1365516056772; Tue, 09 Apr 2013 07:00:56 -0700 (PDT) Original-Received: by 10.76.88.168 with HTTP; Tue, 9 Apr 2013 07:00:56 -0700 (PDT) X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2607:f8b0:4003:c01::232 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:158809 Archived-At: --001a11c21d1a7fc4a304d9edfb2b Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: quoted-printable >>> 1. File structuring with outcommented Org-mode headlines (;; * Headline= ) >> >> There is already a standard for that: >> >> ;;; Headline >> ;;;; SubHeadline >> ;;;;; SubSubHeadline > > But the lisp convention is the opposite: Perhaps the Elisp manual needs an update, because it doesn't at all describe what Stefan does. http://www.gnu.org/software/emacs/manual/html_mono/elisp.html#Comment-Tips "Comments that start with four semicolons, =91;;;;=92 ... are used for head= ings of major sections". "Comments that start with three semicolons, =91;;;=92 ... are used, occasionally, for comments within functions [and] sometimes for comments that are between functions." --001a11c21d1a7fc4a304d9edfb2b Content-Type: text/html; charset=windows-1252 Content-Transfer-Encoding: quoted-printable >>> 1. File structuring with outcommented Org-mode headlines (;; *= Headline)
>>
>> There is already a standard for that:>>
>>=A0=A0=A0 ;;; Headline
>>=A0=A0=A0 ;;;; SubHe= adline
>>=A0=A0=A0 ;;;;; SubSubHeadline
>
> But the lisp convent= ion is the opposite:

Perhaps the Elisp manual needs an update, becau= se it doesn't at all describe what Stefan does.

http= ://www.gnu.org/software/emacs/manual/html_mono/elisp.html#Comment-Tips<= br>
"Comments that start with four semicolons, =91;;;;=92 ... are used= for headings of major sections".

"Comments that start wit= h three semicolons, =91;;;=92 ... are used, occasionally, for comments with= in functions [and] sometimes for comments that are between functions."=


--001a11c21d1a7fc4a304d9edfb2b--