all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Miles Bader <miles.bader@necel.com>
Cc: Emacs-Devel <emacs-devel@gnu.org>
Subject: Re: changing function signatures and no library version # => must use too-general test
Date: Wed, 26 Apr 2006 11:41:55 +0900	[thread overview]
Message-ID: <buod5f512j0.fsf@dhapc248.dev.necel.com> (raw)
In-Reply-To: <DNEMKBNJBGPAOPIJOOICCEEDDFAA.drew.adams@oracle.com> (Drew Adams's message of "Tue, 25 Apr 2006 14:48:53 -0700")

"Drew Adams" <drew.adams@oracle.com> writes:
>     Some functions are known to be "exported"
>
> I don't know what you mean here. Do you mean documented in the manual?
>
>     in which case we have to be
>     careful, which is already a pain in the _|_ at times, but if we start to
>     have to be careful like that with each and every function, it's
>     going to be *really* annoying.
>
> Annoyance to developers is important, but it is not as important as clean
> software and clear software maintenance.

Elisp doesn't have a well-defined notion of interfaces, so it's
_possible_ that just about any random "internal" function will get
called by an external package.  However it would be completely absurd to
try and maintain absolute compatibility for _every_ function.

So it ends up being a judgement call:  If I judge a function to be
"internal" (and no evidence that people are using it despite that), then
I can decide to put the burden on external packages (to fix their code)
rather than on myself (to do the additional work and add the additional
cruft required for maintaining compatibility).  If I judge a function to
be "an interface", I will likely put the burden on myself.  I think this
is fair tradeoff.

If one is writing an external package, there are some vague clues one
can use to avoid problems -- as you suggest, if it's documented in the
manual, it's probably thought of as some sort of official interface, and
is less likely to be changed incompatibly; if it doesn't even have a
doc-string, it's likely thought of as an internal function.

-Miles
-- 
A zen-buddhist walked into a pizza shop and
said, "Make me one with everything."

  reply	other threads:[~2006-04-26  2:41 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-04-25 17:30 changing function signatures and no library version # => must use too-general test Drew Adams
2006-04-25 18:57 ` Stefan Monnier
2006-04-25 19:39   ` Drew Adams
2006-04-25 20:35     ` Stefan Monnier
2006-04-25 21:48       ` Drew Adams
2006-04-26  2:41         ` Miles Bader [this message]
2006-04-26  4:55         ` Stefan Monnier
2006-04-26  6:21           ` Drew Adams

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=buod5f512j0.fsf@dhapc248.dev.necel.com \
    --to=miles.bader@necel.com \
    --cc=emacs-devel@gnu.org \
    --cc=miles@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 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.