From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.devel Subject: Re: Naming guidelines for ELPA packages Date: Sun, 14 May 2023 07:47:27 +0000 Message-ID: <87ednjicc0.fsf@posteo.net> References: <87ttwjbfqq.fsf@gmail.com> <83y1lv5qe9.fsf@gnu.org> <0c04d76f-cca9-8a33-14fe-b9ad96a2b9aa@gmail.com> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="36914"; mail-complaints-to="usenet@ciao.gmane.io" Cc: rms@gnu.org, eliz@gnu.org, relekarpayas@gmail.com, susam.pal@gmail.com, emacs-devel@gnu.org To: Jim Porter Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun May 14 09:48:20 2023 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 1py6Sp-0009ME-AC for ged-emacs-devel@m.gmane-mx.org; Sun, 14 May 2023 09:48:19 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1py6S7-0000Qe-NG; Sun, 14 May 2023 03:47:35 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1py6S6-0000QW-1J for emacs-devel@gnu.org; Sun, 14 May 2023 03:47:34 -0400 Original-Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1py6S4-0004JL-7S for emacs-devel@gnu.org; Sun, 14 May 2023 03:47:33 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 5EC8E240031 for ; Sun, 14 May 2023 09:47:29 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1684050449; bh=v+INy5HGjP7xKv8Sr7Y5UL6UWgc7yKVd1dh8RygnRDQ=; h=From:To:Cc:Subject:Autocrypt:Date:Message-ID:MIME-Version:From; b=QmL8buhRajpKpCRulQ2fvALsMYoeMlsmiIcUmOtb1Zrn9064Uac3fzmoUVISVwHjf ymrSgPKlHfkJkWiLBOezgQm/DSW9+DUs0RuziC3FymVd4mO9TF6P1MEsBhRop9LxRP 88TRPps3ed7QrCx5q1EESCNRi3jRRIJEkiXzr0DVfJk/8KHgvo+YV6LXdHmr8CBRoK I9u3XAv9HwPxE6bWY9uD+XknZ3R0gGG6mY90TxVUUeFEULj9H/xHRVbACDZVKmrZAP 94DzuVM32pXiPmLcC6juDMIILd6TNARbBHH0QrfXTU4UFXDd9UvSLUWp/A3IJPZXsa p/Rf6CM1Y77zw== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4QJvjX3T3pz6tvh; Sun, 14 May 2023 09:47:28 +0200 (CEST) In-Reply-To: <0c04d76f-cca9-8a33-14fe-b9ad96a2b9aa@gmail.com> (Jim Porter's message of "Sat, 13 May 2023 21:29:42 -0700") Autocrypt: addr=philipk@posteo.net; keydata= mDMEZBBQQhYJKwYBBAHaRw8BAQdAHJuofBrfqFh12uQu0Yi7mrl525F28eTmwUDflFNmdui0QlBo aWxpcCBLYWx1ZGVyY2ljIChnZW5lcmF0ZWQgYnkgYXV0b2NyeXB0LmVsKSA8cGhpbGlwa0Bwb3N0 ZW8ubmV0PoiWBBMWCAA+FiEEDg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwMFCQHhM4AFCwkI BwIGFQoJCAsCBBYCAwECHgECF4AACgkQ8xYDWXahwulikAEA77hloUiSrXgFkUVJhlKBpLCHUjA0 mWZ9j9w5d08+jVwBAK6c4iGP7j+/PhbkxaEKa4V3MzIl7zJkcNNjHCXmvFcEuDgEZBBQQhIKKwYB BAGXVQEFAQEHQI5NLiLRjZy3OfSt1dhCmFyn+fN/QKELUYQetiaoe+MMAwEIB4h+BBgWCAAmFiEE Dg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwwFCQHhM4AACgkQ8xYDWXahwukm+wEA8cml4JpK NeAu65rg+auKrPOP6TP/4YWRCTIvuYDm0joBALw98AMz7/qMHvSCeU/hw9PL6u6R2EScxtpKnWof z4oM Received-SPF: pass client-ip=185.67.36.65; envelope-from=philipk@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 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-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:306114 Archived-At: Jim Porter writes: > On 5/13/2023 3:30 PM, Richard Stallman wrote: >> [[[ To any NSA and FBI agents reading my email: please consider ]]] >> [[[ whether defending the US Constitution against all enemies, ]]] >> [[[ foreign or domestic, requires you to follow Snowden's example. ]]] >> > How about something like "devil-keys"? That should make it >> clear that >> > the package has something to do with keys. It doesn't tell exactly what >> > it *does* with those keys, but I think a more-detailed description >> > belongs in the package description or the manual. >> I like this way of serving both goals at once: a clue about what the >> job is, >> and a name to distinguish this package from others for thatjob. >> > > Maybe we could turn this into a general guideline, and document it > somewhere on GNU ELPA (maybe the README). Something like the below? It > could probably use some editorial work, but I thought an example > "story" of choosing a package name might help explain things to > readers. I've suggested something like this in the past, but I can't find my message. Either way, I think this is a good idea that could help avoid a lot of bikeshedding. > ---------------------------------------- > > Naming is hard. To assist package authors, here are some guidelines > for choosing good Emacs package names. Package names should be: > > * Memorable: Aim for short, distinct names that users can easily recall. > * Intuitive: Names don't need to fully describe a package, but they > should at least provide a hint about what the package does. > > For example, suppose I've written a package that provides an interface > between GObjects and Emacs Lisp, and named it "goeli". This isn't a > very good name, since it's not easy to remember (users may find > themselves asking, "Wait... was it 'goli' or 'goeli'?"), and it's > nearly impossible to guess what it does from the name. > > After thinking about it some more, I have a flash of insight: I'll > call it "goblin" (for _GOb_ject _L_isp _In_terface)! This is easy > enough to remember, but it's still not intuitive. > > Perhaps the best name for a package like this would simply be > "gobject". That's both memorable *and* intuitive. > > However, after thinking about it yet again, I find myself > disappointed: while "gobject" is a thoroughly practical name, it's > just not very fun. Instead, I finally opt for a compromise: I'll still > use "Goblin" when documenting the package and prefix names in my code > with "goblin-", but I decide to submit it to GNU ELPA as > "goblin-functions". While this isn't as descriptive as "gobject", it > does at least provide a hint to the reader that this is a collection > of functions (intended for other Lisp authors, as opposed to end > users). I agree with everything up until the last paragraph, but am not convinced that encouraging a "fun name" should be part of the guidelines.