From: Stefan Kangas <stefankangas@gmail.com>
To: Boruch Baum <boruch_baum@gmx.com>,
Emacs-Devel List <emacs-devel@gnu.org>
Subject: Re: adding to emacs coding standard / formatting
Date: Mon, 19 Oct 2020 09:28:45 +0000 [thread overview]
Message-ID: <CADwFkmn8U-TzfRRxfOgRSveYU=-r5wr+WN9xDFRTETrTwUn6Bw@mail.gmail.com> (raw)
In-Reply-To: <20201019031002.iulr45ztrkwsiqlo@E15-2016.optimum.net>
Boruch Baum <boruch_baum@gmx.com> writes:
> 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?
FWIW, I wouldn't like to see this added to our coding standards at a
language level. I find it overly bureaucratic. Files should follow a
standard that makes sense to what its trying to present.
Also, third-party package developers should have some room to maintain
their own standards.
(That said, I'm not a fan of the organization in time.el, as it mixes
unrelated things in one file and violates our prefix naming
conventions.)
next prev parent reply other threads:[~2020-10-19 9:28 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-19 3:10 adding to emacs coding standard / formatting Boruch Baum
2020-10-19 9:28 ` Stefan Kangas [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CADwFkmn8U-TzfRRxfOgRSveYU=-r5wr+WN9xDFRTETrTwUn6Bw@mail.gmail.com' \
--to=stefankangas@gmail.com \
--cc=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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.