unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Boruch Baum <boruch_baum@gmx.com>
Cc: Eli Zaretskii <eliz@gnu.org>,
	 emacs-devel@gnu.org,
	0278C47F-42CE-45C4-B789-83C57DF1A191@bydasein.com
Subject: Re: declare function/macro private
Date: Tue, 08 Jun 2021 11:46:09 -0400	[thread overview]
Message-ID: <jwveedcl65l.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <20210608011456.zc56i2i22tboxcgf@E15-2016.optimum.net> (Boruch Baum's message of "Mon, 7 Jun 2021 21:14:56 -0400")

> The point was just to support Paul Rankin's position that a '--'
> substring isn't a reliable determinant of a function's public/private
> nature, so can't be used as an alternative to an explicit (optional)
> declaration.

FWIW, I do not think a function should be considered non-internal just
because it has to be declared as interactive.

Similarly, the default value of a `foo-function` or `foo-hook` variable
can very much be an internal function, IMO.

The point of "internal" is that other code shouldn't use this directly
because it is subject to change, removal, or unexpected behavior if
called in a different context, ...

More concretely it means that end users are recommended not to do:

   (define-key company-active-map [my-key-sequence]
     #'company--select-next-and-warn)

If they want to use another key than `M-n` they should presumably do:

   (define-key company-active-map [my-key-sequence]
     (lookup-key company-active-map (kbd "M-n")))

[ I don't know if this use of "--" in company.el was a good idea,
  OTOH. ;-)  ]


        Stefan




  parent reply	other threads:[~2021-06-08 15:46 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-07  3:35 declare function/macro private Boruch Baum
2021-06-07  4:49 ` Paul W. Rankin via Emacs development discussions.
2021-06-07  5:59   ` Stefan Monnier
2021-06-07  6:45     ` Paul W. Rankin via Emacs development discussions.
2021-06-07 12:39 ` Eli Zaretskii
2021-06-08  1:14   ` Boruch Baum
2021-06-08  4:20     ` Arthur Miller
2021-06-08  5:49       ` tomas
2021-06-08 15:46     ` Stefan Monnier [this message]
  -- strict thread matches above, loose matches on Subject: below --
2021-06-06  4:27 Paul W. Rankin via Emacs development discussions.
2021-06-06  7:09 ` Omar Polo
2021-06-06  7:18   ` Paul W. Rankin via Emacs development discussions.
2021-06-06  9:53 ` Lars Ingebrigtsen
2021-06-06 12:43   ` Paul W. Rankin via Emacs development discussions.
2021-06-08  9:43     ` Lars Ingebrigtsen
2021-06-08 17:26       ` Robin Tarsiger
2021-06-06 18:05 ` Stefan Monnier
2021-06-06 18:12   ` Tassilo Horn
2021-06-06 20:12     ` Stefan Monnier
2021-06-07  0:51       ` Paul W. Rankin via Emacs development discussions.
2021-06-07  1:37         ` Arthur Miller
2021-06-07  1:43           ` Paul W. Rankin via Emacs development discussions.
2021-06-07 13:38             ` Arthur Miller
2021-06-07  0:59   ` Paul W. Rankin via Emacs development discussions.
2021-06-07  2:54     ` Stefan Monnier
2021-06-07 18:24       ` Arthur Miller

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=jwveedcl65l.fsf-monnier+emacs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=0278C47F-42CE-45C4-B789-83C57DF1A191@bydasein.com \
    --cc=boruch_baum@gmx.com \
    --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).