all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Kenichi Handa <handa@m17n.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: lekktu@gmail.com, tzz@lifelogs.com, emacs-devel@gnu.org
Subject: public APIs and private ones (Re: `C-h v' may offer too many symbols)
Date: Fri, 11 Mar 2011 13:31:30 +0900	[thread overview]
Message-ID: <tl7wrk68ehp.fsf@m17n.org> (raw)
In-Reply-To: <jwv7hc6e7dg.fsf-monnier+emacs@gnu.org> (message from Stefan Monnier on Thu, 10 Mar 2011 21:10:35 -0500)

In article <jwv7hc6e7dg.fsf-monnier+emacs@gnu.org>, Stefan Monnier <monnier@iro.umontreal.ca> writes:

> > Yes, it is a bit silly complete keywords, which are not variables by
> > definition.  I'm going to install this trivial fix.

> Sounds good.  FWIW, here's a patch I have pending for the lexbind branch
> (where special-variable-p is t only for vars that have been defvar'd
> or defconst'd).

This is a little bit different topic, but shouldn't we have
a way to distinguish functions/macros/variables for public
API from those for internal (i.e. only within a specific
package) use only.  For instance, as basic-save-buffer-1 is
just a helper function of basic-save-buffer, there's no need
to list it by C-h f TAB.

In addition, and this is more important, such a
distinguishment makes it easier to maintain a package.  For
instance, when I improve the MIME handling of rmailmm.el,
the most difficult thing was to keep backward compatibility
of existing functions.  It seems that most of them are
intended for internal use only.  If that is clear, I could
have renamed or changed the behaviour of some of them.

---
Kenichi Handa
handa@m17n.org



  parent reply	other threads:[~2011-03-11  4:31 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-03-10 18:52 `C-h v' may offer too many symbols Ted Zlatanov
2011-03-10 19:39 ` Juanma Barranquero
2011-03-11  2:10   ` Stefan Monnier
2011-03-11  2:27     ` Juanma Barranquero
2011-03-11  4:29       ` Stefan Monnier
2011-03-11  4:31     ` Kenichi Handa [this message]
2011-03-11  5:41       ` public APIs and private ones (Re: `C-h v' may offer too manysymbols) Drew Adams
2011-03-11 19:08       ` public APIs and private ones (Re: `C-h v' may offer too many symbols) Ted Zlatanov
2011-03-11 20:28       ` Stefan Monnier

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=tl7wrk68ehp.fsf@m17n.org \
    --to=handa@m17n.org \
    --cc=emacs-devel@gnu.org \
    --cc=lekktu@gmail.com \
    --cc=monnier@iro.umontreal.ca \
    --cc=tzz@lifelogs.com \
    /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.