From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Josh Newsgroups: gmane.emacs.devel Subject: Re: Modern conventions for structuring Emacs Lisp libraries Date: Sun, 6 Oct 2013 12:31:40 -0700 Message-ID: References: <87hacvn8sm.fsf@gmail.com> <87vc1ae1on.fsf@gmail.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=001a11c2b9948419ea04e8179795 X-Trace: ger.gmane.org 1381087938 5300 80.91.229.3 (6 Oct 2013 19:32:18 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 6 Oct 2013 19:32:18 +0000 (UTC) Cc: emacs-devel To: Thorsten Jolitz Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Oct 06 21:32:23 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 1VSu3z-0001e3-3A for ged-emacs-devel@m.gmane.org; Sun, 06 Oct 2013 21:32:23 +0200 Original-Received: from localhost ([::1]:56248 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VSu3y-0001CU-Ku for ged-emacs-devel@m.gmane.org; Sun, 06 Oct 2013 15:32:22 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34889) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VSu3r-0001CD-KR for emacs-devel@gnu.org; Sun, 06 Oct 2013 15:32:20 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VSu3n-0003ps-BL for emacs-devel@gnu.org; Sun, 06 Oct 2013 15:32:15 -0400 Original-Received: from mail-qa0-f41.google.com ([209.85.216.41]:57229) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VSu3n-0003po-6O for emacs-devel@gnu.org; Sun, 06 Oct 2013 15:32:11 -0400 Original-Received: by mail-qa0-f41.google.com with SMTP id ii20so2439465qab.7 for ; Sun, 06 Oct 2013 12:32:10 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:sender:in-reply-to:references:from :date:message-id:subject:to:cc:content-type; bh=Rgr9zJlY+TFBj2g5DiIlRd7BQ35DxM8Qm5QS1W3LrD4=; b=YAJn/Oh//NrB88CKPHrNJa1F2GhAhuyS2oMiAXXbe4f0SjqtW5uWAudQfVbDDcqpAm F6qKE8Fqi7mrrgaH/DcAtITrGc4fGGU7X6U8u+w/1r9hLbg7eDC9t8qat2ZCUSlCLRO5 5zirWrxYiJfjDespXZg3w8LOwL/jbwjL27bd5vUCknOXc1Go7X9+7z2VeZ6YQoqZUOtG thxXwtBsOE77cz3+6rfVSfkXkk7XDLEz3XdUe66Di41L0vNmL7gMyvJcl2Wx+4r8hIVm IobAQCcVA6pxlS1cbJ/XCDlpdEbZ2kfZmNRgpBY44Xn8jxM0zSkjQcLUSIqAO/yJ88WJ JZLg== X-Gm-Message-State: ALoCoQnZ5w2y1k6H50gbU3RUrFO9W5etzPxgXj9RrQdKeeI5SkUrFIiEOjX3jp5mzHz7TBRyvvxp X-Received: by 10.224.6.10 with SMTP id 10mr10398136qax.31.1381087930746; Sun, 06 Oct 2013 12:32:10 -0700 (PDT) Original-Received: by 10.49.38.162 with HTTP; Sun, 6 Oct 2013 12:31:40 -0700 (PDT) In-Reply-To: <87vc1ae1on.fsf@gmail.com> X-Google-Sender-Auth: VjtUqShbR262NqNAwc2fLUcKCmQ X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.85.216.41 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:163927 Archived-At: --001a11c2b9948419ea04e8179795 Content-Type: text/plain; charset=ISO-8859-1 On Sun, Oct 6, 2013 at 10:42 AM, Thorsten Jolitz wrote: > Stefan Monnier writes: > > >> as a second take on this topic, I would like to make the attached > >> proposal for improving the conventions for structuring Emacs Lisp > >> source-code files: When picking up discussions like this one that have been dormant for many months it is helpful to follow up to the original thread or provide a link to the earlier discussion to make it easier for people to refresh their memories or acquaint themselves with where the discussion left off: http://lists.gnu.org/archive/html/emacs-devel/2013-04/msg00263.html > >> 2.2.1 Last Line Pathology > >> ------------------------- > > > > This is a very minor issue, I think. It's trivil to fix it by simply > > ignoring any "trailing header". > Can't the existing tools be modified to accept both, a trailing header > or a trailing comment? It might seem like a very minor issue, but its a > symptom for a not so minor issue - incorrect headline tree-structure. Most of your arguments seem to be predicated on the incorrect assumption that "^;;; Text" can /only/ indicate a first-level headline. The manual page at (info "(elisp) Comment Tips") begins with the text "We recommend these conventions for comments:" and goes on to describe several uses for comments of the above form, of which headlines are but one. Using such comments in any of these ways is perfectly legitimate, not an indication of "pathology" or even incorrect. That same manual page also describes how to cause outline-minor-mode to refrain from considering certain of these comments as headings, namely to follow the semicolons by two or more spaces. --001a11c2b9948419ea04e8179795 Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable
On Sun, Oct 6, 2013 at 10:42 AM, Thorsten Jolitz <tjolitz@gmail.com> wrote:
> St= efan Monnier <monnier@iro.um= ontreal.ca> writes:
>
> >> as a second take on this topic, I would like to make = the attached
> >> proposal for improving the conventions for st= ructuring Emacs Lisp
> >> source-code files:

When pickin= g up discussions like this one that have been dormant for
many months it is helpful to follow up to the original thread or provide a<= br>link to the earlier discussion to make it easier for people to refreshtheir memories or acquaint themselves with where the discussion left
off: http://lists.gnu.org/archive/html/emacs-devel/2013-04/msg00263.ht= ml

> >> 2.2.1 Last Line Pathology
> >> ----= ---------------------
> >
> > This is a very minor issue, I think.=A0 It's tri= vil to fix it by simply
> > ignoring any "trailing header&quo= t;.
> Can't the existing tools be modified to accept both, a trai= ling header
> or a trailing comment? It might seem like a very minor issue, but its = a
> symptom for a not so minor issue - incorrect headline tree-struct= ure.

Most of your arguments seem to be predicated on the incorrect a= ssumption
that "^;;; Text" can /only/ indicate a first-level headline.=A0 T= he manual
page at (info "(elisp) Comment Tips") begins with th= e text "We recommend
these conventions for comments:" and goes= on to describe several uses
for comments of the above form, of which headlines are but one.=A0 Usingsuch comments in any of these ways is perfectly legitimate, not an
indi= cation of "pathology" or even incorrect.=A0 That same manual page= also
describes how to cause outline-minor-mode to refrain from considering
ce= rtain of these comments as headings, namely to follow the semicolons
by = two or more spaces.=A0

--001a11c2b9948419ea04e8179795--