unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Boruch Baum <boruch_baum@gmx.com>
To: Emacs-Devel List <emacs-devel@gnu.org>
Subject: adding to emacs coding standard / formatting
Date: Sun, 18 Oct 2020 23:10:02 -0400	[thread overview]
Message-ID: <20201019031002.iulr45ztrkwsiqlo@E15-2016.optimum.net> (raw)

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.

--
hkp://keys.gnupg.net
CA45 09B5 5351 7C11 A9D1  7286 0036 9E45 1595 8BC0



             reply	other threads:[~2020-10-19  3:10 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-19  3:10 Boruch Baum [this message]
2020-10-19  9:28 ` adding to emacs coding standard / formatting Stefan Kangas
2020-10-19 15:37   ` Drew Adams
2020-10-19 14:24 ` Stefan Monnier
2020-10-19 14:32 ` Eli Zaretskii
2020-10-19 19:59   ` Boruch Baum
2020-10-19 20:07     ` Drew Adams
2020-10-21  4:37       ` Richard Stallman
2020-10-21 14:46         ` Drew Adams
2020-10-20  5:11 ` Richard Stallman
2020-10-20  5:11 ` Richard Stallman
2020-10-20  5:55   ` Boruch Baum
2020-10-20  8:32     ` Eli Zaretskii
2020-10-20  9:30     ` Jean Louis

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201019031002.iulr45ztrkwsiqlo@E15-2016.optimum.net \
    --to=boruch_baum@gmx.com \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).