all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Tassilo Horn <tsdh@gnu.org>
To: Teemu Likonen <tlikonen@iki.fi>
Cc: Drew Adams <drew.adams@oracle.com>, emacs-devel@gnu.org
Subject: Re: Document that symbol prefix "my-" (or other) should be left for users
Date: Tue, 15 Dec 2015 19:22:20 +0100	[thread overview]
Message-ID: <87mvtbinc3.fsf@gnu.org> (raw)
In-Reply-To: <m2a8pclqlw.fsf@newartisans.com> (John Wiegley's message of "Mon,  14 Dec 2015 12:31:07 -0800")

John Wiegley <jwiegley@gmail.com> writes:

>> I have had zero problems but it's also near-zero effort to decide a
>> prefix, document it and obey it. And yes, it's for avoiding name
>> conflicts: so that user's configuration won't harm future Emacs
>> functionality, nor the other way around.
>
>> But it's just a suggestion. I'm not going to have a month long
>> discussion about this. So just ignore it. :-)
>
> I appreciate the effort, Teemu, but I don't think it needs explicit
> documentation. The only package that could conceivably use "my-" as a
> prefix would have to be called "my", otherwise it's in violation of
> other Emacs coding standards.

There are some packages which have a long name and then use a short
abbreviation for (parts of) their functions and variables.  For example,
the `ace-window' package defines functions and variables with the
prefixes ace-* and aw-* (the latter mostly for "private" stuff).  At
least the aw-* symbols could easily clash with Anton Wiegley's private
stuff.

I just picked `ace-window' from the top of my head.  I'm pretty sure
there are more packages which use some abbreviation of their name as
prefix.

Despite clashes, such abbreviations make those packages also less
discoverable using the normal auto-completion features C-h f/v.

Bye,
Tassilo



  reply	other threads:[~2015-12-15 18:22 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-12-13 18:16 Document that symbol prefix "my-" (or other) should be left for users Teemu Likonen
2015-12-13 18:32 ` Drew Adams
2015-12-13 18:56   ` Teemu Likonen
2015-12-14 20:31     ` John Wiegley
2015-12-15 18:22       ` Tassilo Horn [this message]
2015-12-15 18:29         ` John Yates
2015-12-15 19:01           ` Drew Adams
2015-12-15 20:32             ` John Wiegley
2015-12-16  3:12               ` Evans Winner
2015-12-16  6:41                 ` John Wiegley
2015-12-16  0:16   ` David Reitter
2015-12-16  1:26     ` Drew Adams
2015-12-16  1:39       ` Chad Brown
2015-12-16  1:52         ` Drew Adams
2015-12-16  4:41           ` Chad Brown
  -- strict thread matches above, loose matches on Subject: below --
2022-07-10  3:39 Special Event: Davin reveals his own personal additions to Emacs Davin Pearson
2022-07-10 12:57 ` Stefan Monnier
2022-07-10 16:03   ` Document that symbol prefix "my-" (or other) should be left for users Teemu Likonen
2022-07-10 16:59     ` Stefan Kangas
2022-07-10 18:11       ` Bozhidar Batsov
2022-07-10 19:20         ` Tim Cross
2022-07-11  3:17           ` Richard Stallman

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=87mvtbinc3.fsf@gnu.org \
    --to=tsdh@gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    --cc=tlikonen@iki.fi \
    /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.