From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Akib Azmain Turja Newsgroups: gmane.emacs.devel Subject: Re: Naming guidelines for ELPA packages Date: Fri, 19 May 2023 10:33:11 +0600 Message-ID: <87a5y1hreg.fsf@disroot.org> References: <87ttwjbfqq.fsf@gmail.com> <83y1lv5qe9.fsf@gnu.org> <0c04d76f-cca9-8a33-14fe-b9ad96a2b9aa@gmail.com> <87ednjicc0.fsf@posteo.net> <99eafa86-f7fc-8386-cdb4-a9fd706a42a3@gmail.com> <87ttwehfn3.fsf@posteo.net> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8862"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Philip Kaludercic , 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 Fri May 19 06:35:27 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 1pzrpu-00028t-2N for ged-emacs-devel@m.gmane-mx.org; Fri, 19 May 2023 06:35:26 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pzrp5-0005mJ-Tl; Fri, 19 May 2023 00:34: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 1pzrp3-0005mA-LY for emacs-devel@gnu.org; Fri, 19 May 2023 00:34:33 -0400 Original-Received: from knopi.disroot.org ([178.21.23.139]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pzrp1-00045H-Bd; Fri, 19 May 2023 00:34:33 -0400 Original-Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 619194457A; Fri, 19 May 2023 06:34:25 +0200 (CEST) X-Virus-Scanned: SPAM Filter at disroot.org Original-Received: from knopi.disroot.org ([127.0.0.1]) by localhost (disroot.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id zaQXxcFAJMMr; Fri, 19 May 2023 06:34:24 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1684470864; bh=zvn628ivV3ULSAN55+wm+okZtu/qH1gZ1Dj6Z3UxuVg=; h=From:To:Cc:Subject:In-Reply-To:References:Date; b=aQla6fdweyB+DgFFzFe97GGqlsYXQKNLQzZEPDYqon11JSO5cfQuQoLTrU/Mda5iX ogPyLKWNGFBcmSoXGhcN5WygumDAU/XYo777UmNecXVd/JGzAAZUI3zPWLv4/dzCyJ Z37fSPvOAGJHOAS4dg7S8BYARUKz0A2UGjLC3JCUf7vmM5DpQjhZS96wm/YRD8rJ3Q hgyqUniDwjFoPK8W9Eztk5Gzsr9x9b+1BDzFZ4gxoKjKWSegCjT5zF5j07iN/zemxA BzUjYwf9nXV6h8rYgnAY8YYcmCfAJZca4QnoU4SJScwT4baIM85+01o+pRcAfz/0xW BiJDXmSVg95rg== In-Reply-To: (Jim Porter's message of "Thu, 18 May 2023 20:49:02 -0700") Received-SPF: pass client-ip=178.21.23.139; envelope-from=akib@disroot.org; helo=knopi.disroot.org X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, 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:306192 Archived-At: --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Jim Porter writes: > On 5/14/2023 12:33 PM, Philip Kaludercic wrote: >> Jim Porter writes: >>=20 >>> I think I need to adjust the passage a bit to emphasize that the >>> Emacs/ELPA maintainers would *prefer* a simple and straightforward >>> name like "gobject". ... >> That would sound acceptable to me. > > Ok, how about something like the following? I just expanded it a bit > to provide more context and adjusted the wording slightly here and > there (for example, these are now "recommendations" instead of > "guidelines"). > > ---------------------------------------- > > Naming is hard. However, taking some time to choose a good name for > your package will help make your package easier to find and to use. To > assist package authors, here are some recommendations 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, not to mention being > as straightforward as you can get. If possible, the ELPA maintainers > recommend that you choose a name like this. > > However, suppose that at this point, I find myself disappointed: while > "gobject" is a thoroughly practical name, I just don't want to give up > the name "goblin". Instead, I could 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-gobject". While this isn't as concise as "gobject", it does > let the user know right away that this package has something to do > with GObjects. > The example name you suggested, "gobject", is indeed a good name, but there's a little problem that if someone ever comes up with a better package, it won't find any name for itself. =2D-=20 Akib Azmain Turja, GPG key: 70018CE5819F17A3BBA666AFE74F0EFA922AE7F5 Fediverse: akib@hostux.social Codeberg: akib emailselfdefense.fsf.org | "Nothing can be secure without encryption." --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEyVTKmrtL6kNBe3FRVTX89U2IYWsFAmRm/AcACgkQVTX89U2I YWuMjhAAlxGQvlEqWtSFnaUrVzMzm6BZGzk2Zf/43BuMG6dljQYKxY4w3e4SfGzF foPxvpBhlmLIHsWGl2XbprMBYwIm/urpZ8MRI9PFrgiRBnCP/+u5LAgnI9OXUVfe sRVVP0DTB9Rk7ji9R9iFPO9AEg6wwBmvfxsCJPaNUhfi9IykhzOVi9PFCfoN8jhZ u4s4TetcArEkq+f9GXTytUAYlaNEgLRyDydOXXEFZHrhq4IRpSIeDFl1klTNeMa6 zOGj3HpHFQn/aqRzgrHcL3/gttMfvjd/Da7+kYGYq/znSnKQXhn6ig6IV+ba6uEx 5ge+D57jPyDBDA9dy7eajEsI0KWTzJBSvC/W/PFxnkktpK3Q9SPkAV9PRV00ZlNV xfnrCjzrcQfaY0v6tSrg+pjWjhZaQNC4hGo4tGtGDt2+4W8aLIT0QN8xxCB9DkVX GKD8V4BDsqkj6rGdshjYyjItFXgx0oC5X1mK/t5O3pm9hbZIwYAUo4RNJpwEZY7q pLvNIyY34qci7bzHQXFK6nfTmWGIewohV8C+67qMynEyYwRKURJ1CT0wD/vFCXdC tr1TEA2AMkdqrbg9PWQujYzBlERrsw0O0OWcO4VAKMCEoCmStd+41luuQqhAxTzf 1KDh7rKtDPhPEQQmlGKRU4R9s7RArhiA8m4A31XyrJ0qjd5ywpc= =lC9U -----END PGP SIGNATURE----- --=-=-=--