From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#46899: 28.0.50; Inconsistency in Elisp manual section Emacs Lisp Coding Conventions Date: Thu, 04 Mar 2021 18:38:32 +0100 Message-ID: <87mtvivmxz.fsf@gnus.org> References: <877dmoqmvy.fsf@disroot.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="31772"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: 46899@debbugs.gnu.org To: "Jorge P. de Morais Neto" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Mar 04 18:39:31 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1lHrwh-000892-6s for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 04 Mar 2021 18:39:31 +0100 Original-Received: from localhost ([::1]:56522 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lHrwg-0000ra-43 for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 04 Mar 2021 12:39:30 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52300) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lHrwE-0000qC-Qm for bug-gnu-emacs@gnu.org; Thu, 04 Mar 2021 12:39:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:48554) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lHrwE-00037p-FC for bug-gnu-emacs@gnu.org; Thu, 04 Mar 2021 12:39:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lHrwE-0002oq-DU for bug-gnu-emacs@gnu.org; Thu, 04 Mar 2021 12:39:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 04 Mar 2021 17:39:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 46899 X-GNU-PR-Package: emacs Original-Received: via spool by 46899-submit@debbugs.gnu.org id=B46899.161487952610812 (code B ref 46899); Thu, 04 Mar 2021 17:39:02 +0000 Original-Received: (at 46899) by debbugs.gnu.org; 4 Mar 2021 17:38:46 +0000 Original-Received: from localhost ([127.0.0.1]:60100 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lHrvx-0002oJ-Vc for submit@debbugs.gnu.org; Thu, 04 Mar 2021 12:38:46 -0500 Original-Received: from quimby.gnus.org ([95.216.78.240]:52734) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lHrvv-0002o4-S4 for 46899@debbugs.gnu.org; Thu, 04 Mar 2021 12:38:44 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=CxHWaHukkD6859RCGNNz5AKATnJxMdccsjcoxCA7bzQ=; b=b1GZ+ZNtN26/cCfJnoVBOSgEWI kQ8f3vpmLxNO8abpBNa3HUPC9uGpPtaprbB177tx1ZFTv6rGFNrFWPqxi7HcvTGYveu9L6knN600p 6nhH9z1ZIJdgr/5fzR75LVryxFwD2aceKqEo47PPnmmTbWtninKid4LR5BKbj7PiW3P8=; Original-Received: from cm-84.212.220.105.getinternet.no ([84.212.220.105] helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1lHrvm-0005HK-4A; Thu, 04 Mar 2021 18:38:37 +0100 X-Now-Playing: Black Lips's _Fire Comp 2020_: "Locust" In-Reply-To: <877dmoqmvy.fsf@disroot.org> (Jorge P. de Morais Neto's message of "Wed, 03 Mar 2021 12:26:25 -0300") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:201424 Archived-At: "Jorge P. de Morais Neto" writes: > Hi. The section `Emacs Lisp Coding Conventions' (tips.texi) says: > > Also, constructs that define functions, variables, etc., work better > if they start with @samp{defun} or @samp{defvar}, so put the name > prefix later on in the name. That is indeed puzzling -- I wasn't aware that we had any package-specific macros starting with defun-, but indeed: defun-rcirc-command defun-mh defun-cvs-mode Uhm... and those are the only three in the Emacs tree, apparently? > Therefore, developers are instructed to name these constructs starting > with ~defun~ or ~defvar~. But a later paragraph says: > > Constructs that define a function or variable should be macros, not > functions, and their names should start with @samp{define-}. That sounds like what we're actually using. I think removing the bit about defun/defvar might make the most sense here (or just moving the define- thing up there). Opinions? -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no