From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: declare function/macro private Date: Sun, 06 Jun 2021 16:12:42 -0400 Message-ID: References: <0278C47F-42CE-45C4-B789-83C57DF1A191@bydasein.com> <87v96qrguz.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16923"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: "Paul W. Rankin" , emacs-devel@gnu.org To: Tassilo Horn Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 06 22:13:53 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1lpz9d-0004Co-99 for ged-emacs-devel@m.gmane-mx.org; Sun, 06 Jun 2021 22:13:53 +0200 Original-Received: from localhost ([::1]:52624 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lpz9c-0000xJ-8A for ged-emacs-devel@m.gmane-mx.org; Sun, 06 Jun 2021 16:13:52 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42836) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lpz8h-0007vq-Ol for emacs-devel@gnu.org; Sun, 06 Jun 2021 16:12:55 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:54638) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lpz8e-0001US-N4; Sun, 06 Jun 2021 16:12:54 -0400 Original-Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 4C1288033D; Sun, 6 Jun 2021 16:12:49 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 8EC7880385; Sun, 6 Jun 2021 16:12:43 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1623010363; bh=63JY4lHJalaPzHZ68eyYg33/iugRkn9YLUkC9OTCGzI=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=CC2G7rog0bcQ2UH9bjaN5e5DtYx7tLK3yOy7qfCvI4CO7EvzcPuxAfhh/+9QfytpG nH1L4Ar5GkBKqFX8jlhPudBukICwV+RAoCqIMpBFaPZ/xJE79XW9qLmjZlbSkH0qb7 5zuIlcUPQIV+olNEhiCvud09AJjv4yj+rl4e10BhT8FBW0mglJ2APGOP5SUXNIiAjQ VL6PuKKF+qF3vT58xmC1+R9hJ6Z0Cs2m8nYrZ4y73pabdRPYdy7ond5bBZkki/LJUF q5L78BtvZRRrfyirm5tfFE/TsJLa/kMndRl8oinQDYPHhTGp40AEKQ/BxxhOGta4fW 90ODJvP5DQGjA== Original-Received: from alfajor (69-196-163-239.dsl.teksavvy.com [69.196.163.239]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 4CBF5120CF3; Sun, 6 Jun 2021 16:12:43 -0400 (EDT) In-Reply-To: <87v96qrguz.fsf@gnu.org> (Tassilo Horn's message of "Sun, 06 Jun 2021 20:12:49 +0200") Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:270499 Archived-At: Tassilo Horn [2021-06-06 20:12:49] wrote: > Stefan Monnier 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. Stefan