From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#24829: 24.5; `easy-mmode-define-navigation': rename `define-...', per convention Date: Tue, 11 Aug 2020 17:46:10 -0700 Message-ID: References: <787c4f0e-4cd2-46b9-9e7a-1cc694e8b71c@default> <871rybiqtx.fsf@mouse.gnus.org> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="20100"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: 24829@debbugs.gnu.org To: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Aug 12 02:47:12 2020 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 1k5evA-00057e-2F for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 12 Aug 2020 02:47:12 +0200 Original-Received: from localhost ([::1]:37144 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1k5ev8-0002Cj-Gu for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 11 Aug 2020 20:47:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56996) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1k5euz-0002CZ-Tx for bug-gnu-emacs@gnu.org; Tue, 11 Aug 2020 20:47:01 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:58813) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1k5euz-0007eh-Kh for bug-gnu-emacs@gnu.org; Tue, 11 Aug 2020 20:47:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1k5euz-0006su-JW for bug-gnu-emacs@gnu.org; Tue, 11 Aug 2020 20:47:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 12 Aug 2020 00:47:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 24829 X-GNU-PR-Package: emacs Original-Received: via spool by 24829-submit@debbugs.gnu.org id=B24829.159719317926393 (code B ref 24829); Wed, 12 Aug 2020 00:47:01 +0000 Original-Received: (at 24829) by debbugs.gnu.org; 12 Aug 2020 00:46:19 +0000 Original-Received: from localhost ([127.0.0.1]:42117 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1k5euI-0006rd-Nt for submit@debbugs.gnu.org; Tue, 11 Aug 2020 20:46:18 -0400 Original-Received: from mail-yb1-f181.google.com ([209.85.219.181]:34739) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1k5euG-0006rR-Sj for 24829@debbugs.gnu.org; Tue, 11 Aug 2020 20:46:17 -0400 Original-Received: by mail-yb1-f181.google.com with SMTP id c9so457389ybq.1 for <24829@debbugs.gnu.org>; Tue, 11 Aug 2020 17:46:16 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:in-reply-to:references:user-agent :mime-version:date:message-id:subject:to:cc; bh=LjZiFy1fJK+eJm/mq2KIVoqG71/jA/bLSYC3yoPUXj8=; b=F4F/8lSMUFC+Tz4A0+tWeC7HpBMQTP/hlWLcT28f4h9yaaBL09n9Qy8ncpt3Chn5kN XTBqW3UXN2GSCDzzG+dKA4vMrg5xs9z6iENhb0L4gEu14nuSqOWul8i1pKylI9ZWpz3S pbFHiQWN/zcfvhbTmN8enc07Ga/O+fv3SSY+CPEZQGc83hy6M+PmSe8gw+/AZV63svFU T79j3YpPk/CZSkHMeSOJCqP0OyBmrLhR1Jf7UvDQ4HxE832871wOUPqQ7lwY/2+UzMq8 x5c6N+U7MuTIZZmF82Gkj93nwTFHzJpoy+d6JyOKWIA07sFwlFsZfX02NIz/s5/owIpg PlYg== X-Gm-Message-State: AOAM532sqQQcrYX8O1O66G1+nkmmgUF53oMqcOb5qlVZUCBywnJlQFXS fJl568KyrOAZimli2nOJcSeL0YBPOfuLRuJDzvo= X-Google-Smtp-Source: ABdhPJxnseuWCDHQz+iGds4pWpACCqLm3kWXWp9ZMLhu35dejf+kW/ftM3G5auPLerI1TrhvpWwcwWB5HTPTC2AP+xo= X-Received: by 2002:a5b:410:: with SMTP id m16mr51122262ybp.309.1597193171280; Tue, 11 Aug 2020 17:46:11 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Tue, 11 Aug 2020 17:46:10 -0700 In-Reply-To: <871rybiqtx.fsf@mouse.gnus.org> (Lars Ingebrigtsen's message of "Sat, 27 Jul 2019 14:50:50 +0200") 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:184708 Archived-At: Lars Ingebrigtsen writes: > Drew Adams writes: > >> Macro `easy-mmode-define-navigation' apparently defines Emacs commands >> (functions). Per the Emacs Lisp coding conventions, its seems that the >> macro should be renamed. >> >>>>>From (elisp `Coding Conventions': >> >> Constructs that define a function or variable should be macros, not >> functions, and their names should start with `define-'. The macro >> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ >> should receive the name to be defined as the first argument. That >> will help various tools find the definition automatically. Avoid >> constructing the names in the macro itself, since that would >> confuse these tools. > > I'm not sure how much of an edict that's supposed to be. > > easy-mmode has other functions/macros using the same naming convention > (like easy-mmode-define-syntax), but those don't define functions, of > course. > > We could change easy-mmode-define-navigation to, say, > `define-easy-mmode-navigation', but I'm not sure that would be a net > win, confusion wise. Anybody have an opinion here? FWIW, I also think the original name is less confusing. It also includes the package name prefix, which is probably nice given its surrounding context. Best regards, Stefan Kangas