unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Jim Porter <jporterbugs@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>, Adam Porter <adam@alphapapa.net>
Cc: emacs-devel@gnu.org
Subject: Re: Names are not descriptions; descriptions are not names
Date: Fri, 12 May 2023 09:33:41 -0700	[thread overview]
Message-ID: <a876c12c-641b-fb19-0117-86454ae18fa9@gmail.com> (raw)
In-Reply-To: <835y8y3sq1.fsf@gnu.org>

On 5/12/2023 12:37 AM, Eli Zaretskii wrote:
> Again, there's no requirement to allow users distinguishing between
> similar packages just by looking at the name.  That can only be done
> by reading the package's description.
> 
> IOW, the name should allow some kind of initial filtering: if I'm not
> interested in key translation, I don't need to look further at a
> package named key-transl.  It's the same first-order filtering we
> apply to email by just looking at the Subject.  Nothing more, nothing
> less.

Looking at the list of packages in GNU ELPA, almost all of them have a 
description well within the limits of what we'd expect from an email 
Subject. To use your example of "42", while that alone would be cryptic, 
a Subject like "42: The answer to life, the universe, and everything" 
would be ok, I think.

That being said, are there places we can make package descriptions more 
visible? Both "M-x list-packages" and the ELPA package list on the web 
show the descriptions prominently, so I find them both to be very easy 
to find packages, even if they have cryptic names. However, there may be 
further improvements we should make in this area. Packages can have 
keywords, so improving those might help, or maybe we could add metadata 
for broad package categories (e.g. "theme", "key bindings", "major 
mode", etc)...

Still, there's room for a light touch with improving package names 
(especially if we let the actual package *identifier* be a slight 
variation on the name). For example, the Devil package could otherwise 
stay the same, but we could give it a package identifier of 
"devil-keys". The functions and commands would still just be 
"devil-FOO", and the documentation could still say "devil" instead of 
"devil-keys" (except when talking about how to install the package, of 
course). Would that be a reasonable compromise for cases like this?



      reply	other threads:[~2023-05-12 16:33 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-12  4:01 Names are not descriptions; descriptions are not names Adam Porter
2023-05-12  4:47 ` Jim Porter
2023-05-12 20:02   ` Dr. Arne Babenhauserheide
2023-05-12  6:04 ` Po Lu
2023-05-12  7:46   ` Adam Porter
2023-05-12 13:31     ` [External] : " Drew Adams
2023-05-12 13:58     ` Po Lu
2023-05-12 19:10       ` Dmitry Gutov
2023-05-12 17:52   ` chad
2023-05-12 19:11     ` Eli Zaretskii
2023-05-12  6:42 ` Philip Kaludercic
2023-05-12  7:37 ` Eli Zaretskii
2023-05-12 16:33   ` Jim Porter [this message]

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=a876c12c-641b-fb19-0117-86454ae18fa9@gmail.com \
    --to=jporterbugs@gmail.com \
    --cc=adam@alphapapa.net \
    --cc=eliz@gnu.org \
    --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).