From: Arthur Miller <arthur.miller@live.com>
To: "Paul W. Rankin" via "Emacs development discussions."
<emacs-devel@gnu.org>
Cc: "Paul W. Rankin" <pwr@bydasein.com>,
Stefan Monnier <monnier@iro.umontreal.ca>,
Tassilo Horn <tsdh@gnu.org>
Subject: Re: declare function/macro private
Date: Mon, 07 Jun 2021 03:37:03 +0200 [thread overview]
Message-ID: <AM9PR09MB49777EF79D6DFBA4DAF0484F96389@AM9PR09MB4977.eurprd09.prod.outlook.com> (raw)
In-Reply-To: <CE3733F6-73D2-4ECC-9722-875D134C1184@bydasein.com> (Paul W. Rankin's message of "Mon, 7 Jun 2021 10:51:12 +1000")
"Paul W. Rankin" via "Emacs development discussions."
<emacs-devel@gnu.org> writes:
>> On 7 Jun 2021, at 6:12 am, Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>>
>> Tassilo Horn [2021-06-06 20:12:49] wrote:
>>> Stefan Monnier <monnier@iro.umontreal.ca> writes:
>>>> I think the "--" convention actually includes an extra information
>>>> compared to yours which could be useful here: we could warn for uses
>>>> of "foo--" if and only if the use appears in something whose name
>>>> doesn't start with "foo-".
>>>>
>>>> IOW, use the string before the "--" as the definition of the "library"
>>>> (so that would support cases where a library is spread over several
>>>> files, as well as the case where a single file contains "internal
>>>> libraries").
>>>
>>> If my package was structured like
>>>
>>> foo.el
>>> foo-search.el
>>> foo-parse.el
>>>
>>> I'd find it quite natural to name a private function in foo-search.el
>>> `foo-search--do-stuff'. Of course, it's ok if my `foo-base-do-stuff'
>>> function from foo.el calls it but it would trigger a warning with your
>>> approach because the "library" would be foo-search, no?
>>
>> Indeed, the idea is that you'd have to use foo--search-do-stuff for
>> those functions which are private to your foo package but not to
>> foo-search.el, whereas you'd use foo-search--do-stuff for functions
>> which are not only private to your package but even private to
>> foo-search.el.
>
> If there is a lake with a bunch of alligators in it, it would be a good thing to put up a sign that says "Danger: No swimming, Alligators".
>
> Such a sign's sole purpose is to provide warning to people considering swimming in the alligator-infested lake, it does not actually prevent them from being eaten by alligators should they ignore the warning.
>
> What I'm suggesting is to put up the sign, not to figure out a way to prevent alligators from eating swimmers who ignore the sign.
Isn't a '--' that sign?
next prev parent reply other threads:[~2021-06-07 1:37 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-06 4:27 declare function/macro private 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 [this message]
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
-- strict thread matches above, loose matches on Subject: below --
2021-06-07 3:35 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
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=AM9PR09MB49777EF79D6DFBA4DAF0484F96389@AM9PR09MB4977.eurprd09.prod.outlook.com \
--to=arthur.miller@live.com \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
--cc=pwr@bydasein.com \
--cc=tsdh@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).