From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Boruch Baum Newsgroups: gmane.emacs.devel Subject: adding to emacs coding standard / formatting Date: Sun, 18 Oct 2020 23:10:02 -0400 Message-ID: <20201019031002.iulr45ztrkwsiqlo@E15-2016.optimum.net> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19280"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: NeoMutt/20180716 To: Emacs-Devel List Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Oct 19 05:13:30 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 1kULc1-0004vP-EO for ged-emacs-devel@m.gmane-mx.org; Mon, 19 Oct 2020 05:13:29 +0200 Original-Received: from localhost ([::1]:52752 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kULc0-0005zr-AE for ged-emacs-devel@m.gmane-mx.org; Sun, 18 Oct 2020 23:13:28 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36004) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kULYs-0005NP-FT for emacs-devel@gnu.org; Sun, 18 Oct 2020 23:10:14 -0400 Original-Received: from mout.gmx.net ([212.227.17.20]:43247) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kULYm-0001Uc-KD for emacs-devel@gnu.org; Sun, 18 Oct 2020 23:10:11 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1603077006; bh=YvbZB5kDjce/V83oPvP8g72gcK3lKrfXsfjfLKfHMPY=; h=X-UI-Sender-Class:Date:From:To:Subject; b=CbBoNLPH1OsON+M6R8PtmQQQqn/+ivSWSOwAZu7vBf/UmrnD4989z2NZqjW3k/0J6 1DL+CpZPozUH0uJ10xJkg4VPXAWLFh7UFbbjsKhG53BIZg5a1gtUP2tv0UF5TmsVDq 8rRXOakurG63CJWn0tz/d1Q3JXNHwltp47/MED/4= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from E15-2016.optimum.net ([72.89.170.172]) by mail.gmx.com (mrgmx104 [212.227.17.174]) with ESMTPSA (Nemesis) id 1McYCb-1jrist1Cl3-00d0Oa for ; Mon, 19 Oct 2020 05:10:06 +0200 Content-Disposition: inline X-Provags-ID: V03:K1:X7EMHV5Tqj27X2JBtf5alwfqlCf89mkG2GntM14bIHfTRrY7brC bTqRIOqlmshv0D8tYrLJWLEbtb2fIhzWNPcMtuIs7pXL7+pmPwRv6wvsxMm28siRqn+e3jK cbSTl7n3mUrL9m0raqxcwcG5C7KBuoeXUqgu5vLubfDxWRFzDBDvvNOA+l2GuWd/ljBFvrl gIAhl3BQoug2hnoZZR5+A== X-UI-Out-Filterresults: notjunk:1;V03:K0:ZNRuyZVAwcA=:xLKDlMiS8mzDYE+aKitTRZ jf5+R55oDAxO22zqwCzC6fpeo3GtUZ+GDrpmlEUNoXtmhnj3OWSRP8bkqajoNppdENioNUkc3 M+nRiNqQcpw2Uo6fkuq4JQAIBrKuyAsiiHLO2q3SW4HP3TdrOtg3EysY/cJFPO3TrJccEgcNb pR1qs3hpQmDrS7pbIO3Kx8nygqsl143CCCHKrJrGIkZWUHLyqXHmDuwQH+ss9AdSFP33Azs+A FETfwYbVEWyaqCoYrZKGcwPER5O9tQk1y+8Req622J9DE2x9hzP/u/QCneEcKScBDndGSzr0i 1/g7mtyb5+2nxGfGo+catKb+nWudVATY8DBu1qanV5Cs4BaDxfH9NwY/O0YivLIqWiThjMkwZ JjscNItv0xA2bEOytla3Wzz3+eGFSNjln9ZWtoGpVu2rqA1lDPbKlKDlYtKFA++gBef7mmibo JBuJ2ueJmr7eULq3ekrRjQFjNN4GxYl6gezdIedpfdPcTbIEH9tQDFCJHVGlDrUqJpRnAFJGI u5WqTTd1+NOptW/8fKRbCW/L/AhhDMxS/Ah7tkLgAV5Mw84zHV9XBYXgRm6ic56M3T8XKc2he UgC/jT+W+krqzKJWdRhQTtX5iXe6bury/F+4lPnFDw4nb+23eQK0i2aqpB0sk0LpW4yvXmkJY vPD9FNxPH4A5+1GV8h8H5G0V8sPtAAevPOTNtzfFN2H6xgQeEb2UYu51O1kPuswHy8aa8xRqz R24FUvSPneBokrfKKurJmI5na5JH3fhlgJ+2SCHUm4/TBUlm6oAzOHVy7eDwrpZKp0ib/4Z6 Received-SPF: pass client-ip=212.227.17.20; envelope-from=boruch_baum@gmx.com; helo=mout.gmx.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/18 23:10:06 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, 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:258083 Archived-At: My work apropos the thread " ~Make emacs friendlier: package documentation= [POC CODE INCLUDED]" highlighted to me benefit to proposing to add to the accepted / suggested / required format of emacs elisp packages. I had expecting symbol definitions to be grouped together by symbol type and function, eg. all `defcustom's to be listed together in a section beginning "^;;; Customization variables:", and so on for symbol categories ";;; Global variables:", ";;; Buffer-local variables", ";;; Internal functions:", ";;; Hook functions:", ";;; Interactive functions:", etc. That isn't the case in package time.el, so that's probably also the case in other packages. Should doing so be added to the coding standard? Also, this is an opportunity to address a pet peeve: I occasionally see code either defining keybindings to lambda functions, or setting lambda functions as elements of function lists (eg. lists of hook functions). I'd like to propose that those uses be banned because of their difficulty to modify. =2D- hkp://keys.gnupg.net CA45 09B5 5351 7C11 A9D1 7286 0036 9E45 1595 8BC0