From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Yuan Fu Newsgroups: gmane.emacs.devel Subject: Re: Regarding outline headings in emacs-lisp libraries Date: Sun, 26 Jul 2020 13:00:51 -0400 Message-ID: <6391855C-7092-4B2D-8AA7-ADC3D52F644B@gmail.com> References: <875zalolt7.fsf@bernoul.li> <87v9ikmmly.fsf@bernoul.li> <87imeal72x.fsf@bernoul.li> <87ft9el2bl.fsf@bernoul.li> Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.80.23.2.2\)) Content-Type: multipart/alternative; boundary="Apple-Mail=_FF46ED64-84B4-4186-B9B7-301FCF78A50D" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="34894"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Stefan Monnier , emacs-devel@gnu.org To: Jonas Bernoulli Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jul 26 19:02:03 2020 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1jzk2F-0008yQ-5K for ged-emacs-devel@m.gmane-mx.org; Sun, 26 Jul 2020 19:02:03 +0200 Original-Received: from localhost ([::1]:33394 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jzk2E-00076q-3v for ged-emacs-devel@m.gmane-mx.org; Sun, 26 Jul 2020 13:02:02 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59052) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jzk1B-0006Xa-1P for emacs-devel@gnu.org; Sun, 26 Jul 2020 13:00:57 -0400 Original-Received: from mail-qt1-x82a.google.com ([2607:f8b0:4864:20::82a]:34170) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jzk19-0005Sf-9U for emacs-devel@gnu.org; Sun, 26 Jul 2020 13:00:56 -0400 Original-Received: by mail-qt1-x82a.google.com with SMTP id x12so2011509qtp.1 for ; Sun, 26 Jul 2020 10:00:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:message-id:mime-version:subject:date:in-reply-to:cc:to :references; bh=ZSZhymLvNWj8D/nMgIZYnXs2rz83Nmodu2dkcLXd25M=; b=eq+hjSlFOtgKZNwuZnXnRvaiu2thCNJg4UsfbxC3IFASFA9GP+Os9Ny7lUkxg5thKm ApNsMXsT44uXz6ld9RsBB/DMFsCqEG8vg8DOqz28cR7pgsI3FDSKzyBGAHgZ++nJW7c7 NGV+eOpTSS8setCKngkmu1UOz3pwZFARJrvEgpD/rj/ymkCYmu0amLRJq7zcv2f6suAF BI6nzm+7VykwSzBYPQ5P5fzK5knJbiV97w6QnoGHH1QvYGr4362psvZjNiYQHRHEHism WQ4H7Co7TFp4jfdoTbNjV3d9iQF5Rn8p8tLUpJ+yR4NmPgv5taaHvD67yYzN+SbJmImr 9NBQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:message-id:mime-version:subject:date :in-reply-to:cc:to:references; bh=ZSZhymLvNWj8D/nMgIZYnXs2rz83Nmodu2dkcLXd25M=; b=CQt3BmT/qKq2LmYhSRk+4cq5y9XJPL2I0f4E89xfHEVlUs21/m3U2A6ET+OnMiJk2O RKpBbQclbnP0F84Ank/gOp4ZrfX6kdPiCDBOBXwGUXJUyRJZDPwx2MLf9fgaRB0Gp9sg /u1Ld8TvfUb6n7ozyu+7FisHnBRbfj17Gbb/c1JOp72tJS2Coc2CdR1gDR6uCO8ulx94 qGwG4mT2Jml9cFt0Sp4T9SSki7cmu91ggNRuh92jmq0oxYHmpTfvwsU9itbspPJOj8nc Vo5rLVZq78/Oq72O3zv7wlrsNlWjcbsF7eiMRC3QwTDYhIXaXE7uiRKadoqrGrPF3WnR lnjA== X-Gm-Message-State: AOAM532vHVmzkzCi9raz2uHbeJuo32E4tbacObyIc5GaQejxH9KSAKAO ccqOUr3AnSH1k1kq510niqg= X-Google-Smtp-Source: ABdhPJyYyCGuV0E8/uaXQ2j6fUXyBitAs2aUWr60e5yqHGnZRVKZae+KmRQrSLkG+1+Kjusc6wdb6w== X-Received: by 2002:ac8:2601:: with SMTP id u1mr18544455qtu.170.1595782853502; Sun, 26 Jul 2020 10:00:53 -0700 (PDT) Original-Received: from ?IPv6:2601:98a:4200:9210:2d81:3010:97ef:47bc? ([2601:98a:4200:9210:2d81:3010:97ef:47bc]) by smtp.gmail.com with ESMTPSA id s38sm11157237qts.78.2020.07.26.10.00.52 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Sun, 26 Jul 2020 10:00:53 -0700 (PDT) In-Reply-To: <87ft9el2bl.fsf@bernoul.li> X-Mailer: Apple Mail (2.3608.80.23.2.2) Received-SPF: pass client-ip=2607:f8b0:4864:20::82a; envelope-from=casouri@gmail.com; helo=mail-qt1-x82a.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:253264 Archived-At: --Apple-Mail=_FF46ED64-84B4-4186-B9B7-301FCF78A50D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=us-ascii > On Jul 26, 2020, at 11:32 AM, Jonas Bernoulli = wrote: >=20 >=20 > - We currently don't put the `provide' form, the local variable > definitions and other "stuff that goes at the end" into a dedicated > "back matter" section. Instead we put these things at the end > whatever other completely unrelated section happens to come last in > the file. >=20 > In my own libraries I name that section "_" and (beside the things > just mentioned that have to go there because they have to be placed > near the end of the file) I also use it for "administrative things", > like adding functions to third-party hooks, test definitions, > font-lock keyword definitions for forms defined across the file. Since we normally put stuff that has side-effects (other than = definitions) in the end of a package (provide, hooks, etc) maybe we can = call it ;;; Side effect or simply ;;; Effect? Or Something in the same = line. Yuan= --Apple-Mail=_FF46ED64-84B4-4186-B9B7-301FCF78A50D Content-Transfer-Encoding: quoted-printable Content-Type: text/html; charset=us-ascii

On Jul 26, 2020, at 11:32 AM, Jonas Bernoulli <jonas@bernoul.li> = wrote:


- We currently don't put the `provide' form, the local = variable
 definitions and other "stuff that goes at the end" into = a dedicated
 "back matter" section.  Instead we put these = things at the end
 whatever other completely unrelated section happens to = come last in
 the file.

 In my own libraries I name that section "_" and (beside = the things
 just mentioned that have to go there because they have = to be placed
 near the end of the file) I also use it for = "administrative things",
 like adding functions to third-party hooks, test = definitions,
 font-lock keyword definitions for forms defined across = the file.

Since we normally put stuff that has = side-effects (other than definitions) in the end of a package (provide, = hooks, etc) maybe we can call it ;;; Side effect or simply ;;; Effect? = Or Something in the same line.

Yuan
= --Apple-Mail=_FF46ED64-84B4-4186-B9B7-301FCF78A50D--