unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Stefan Monnier <monnier@iro.umontreal.ca>
Cc: emacs-devel@gnu.org
Subject: RE: Consistent naming in woman.el
Date: Thu, 4 Feb 2016 09:30:07 -0800 (PST)	[thread overview]
Message-ID: <62c391f3-a3f8-41a3-911e-547c70efe9cc@default> (raw)
In-Reply-To: <<83oabwwgx4.fsf@gnu.org>>

> > Not sure about this case, but such capitalization has been used in some
> > Elisp packages to indicate "internal" vs "exported"
> functions/vars/commands.
> 
> Indeed.  We have something similar in info.el, I think.

And in Customize: `Custom-*' commands.

But no, the convention (FWIW) is _not_ designed to distinguish
"internal" from "exported" things.  (The very notion of "internal"
vs "exported" is somewhat alien to tradtional Emacs, IMO.)

The convention is there to make it easier to match some command
names when completing (including for `C-h f', but mainly for `M-x').
The idea is to not present you with too many, somewhat extraneous,
commands when you use `M-x'.  The names of more esoteric commands
are capitalized, the idea being that you will more likely type
lowercase, and so will not be bothered with those names.

That is, commands that are more commonly expected to be used with
`M-x' are not capitalized when this convention is followed.
Commands that are expected to be invoked less often using `M-x'
(e.g. invoked mainly by keys or menus) are capitalized.

Thus:
`info', but `Info-virtual-index'
`customize-option', but `Custom-help'

Whether this convention is really useful nowadays, since completion
can include partial-complete, substring matching etc., is debatable.
But that was the idea, anyway, AFAIK.



      parent reply	other threads:[~2016-02-04 17:30 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-02-04  4:24 Consistent naming in woman.el Kaushal Modi
2016-02-04  7:47 ` John Wiegley
2016-02-04 13:24 ` Stefan Monnier
2016-02-04 16:59   ` Eli Zaretskii
2016-02-04 19:37     ` Mark Oteiza
     [not found]   ` <<83oabwwgx4.fsf@gnu.org>
2016-02-04 17:30     ` Drew Adams [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=62c391f3-a3f8-41a3-911e-547c70efe9cc@default \
    --to=drew.adams@oracle.com \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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).