From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#66554: [PATCH] Add the public API of Compat to the core Date: Thu, 08 Feb 2024 10:21:14 +0200 Message-ID: <861q9nxt6t.fsf@gnu.org> References: <87pm1ggrdx.fsf@posteo.net> <87h6jiqtsp.fsf@daniel-mendler.de> <835xzyiagj.fsf@gnu.org> <871qamkx0m.fsf@posteo.net> <83wmsdhgw8.fsf@gnu.org> <87wmsdxvz6.fsf@daniel-mendler.de> <878r4ml8sg.fsf@posteo.net> <83v87qwg48.fsf@gnu.org> <87h6jaz8eo.fsf@daniel-mendler.de> <83r0idx1p1.fsf@gnu.org> <87mst1tgrt.fsf@posteo.net> <874jf39rn7.fsf@daniel-mendler.de> <871qa47ch1.fsf@posteo.net> <87a5osfka1.fsf@daniel-mendler.de> <87y1c3s2ts.fsf@posteo.net> <864jer59gm.fsf@gnu.org> <87h6ils91z.fsf@posteo.net> <86r0hpz8o2.fsf@gnu.org> <87r0hpqs8i.fsf@posteo.net> <875xz05h6m.fsf@posteo.net> <86sf24xj9t.fsf@gnu.org> <87plx7e74o.fsf@posteo.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="40024"; mail-complaints-to="usenet@ciao.gmane.io" Cc: mail@daniel-mendler.de, stefankangas@gmail.com, monnier@iro.umontreal.ca, 66554@debbugs.gnu.org To: Philip Kaludercic Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Feb 08 09:22:10 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1rXzfe-000ABH-Bc for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 08 Feb 2024 09:22:10 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rXzfM-0005hE-Al; Thu, 08 Feb 2024 03:21:52 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rXzfI-0005h4-UR for bug-gnu-emacs@gnu.org; Thu, 08 Feb 2024 03:21:48 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rXzfI-0005le-Im for bug-gnu-emacs@gnu.org; Thu, 08 Feb 2024 03:21:48 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rXzfW-0004Aw-Ix for bug-gnu-emacs@gnu.org; Thu, 08 Feb 2024 03:22:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 08 Feb 2024 08:22:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66554 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 66554-submit@debbugs.gnu.org id=B66554.170738050116022 (code B ref 66554); Thu, 08 Feb 2024 08:22:02 +0000 Original-Received: (at 66554) by debbugs.gnu.org; 8 Feb 2024 08:21:41 +0000 Original-Received: from localhost ([127.0.0.1]:58958 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rXzfA-0004AK-GN for submit@debbugs.gnu.org; Thu, 08 Feb 2024 03:21:40 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:60344) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rXzf7-0004A7-Qg for 66554@debbugs.gnu.org; Thu, 08 Feb 2024 03:21:39 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rXzen-0005jw-5Q; Thu, 08 Feb 2024 03:21:17 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=YUNkJ9dljd6CeipP62yV65Wcth7pvc2UFcVqhb90rfQ=; b=dLSO7KG162b4 XVUxWgYyeR/p/iVBiC0OYfrQLj8nRbaK7UiW0hvUKh+WMXyxj7e05i68egyp1O/t4uZ/3na7VQn7m 1gf1frRwfz2VOE3Tacsskn6ZRkGzohsIqccwGQKx7YAlaAwD5dyJlXYQRGzLbhUmbcWnu0tIqd4pI UXXlE3/ukKnBwyhH/KUztINnnyjtpmtxa+aDtgYZAbFHiYzkEwwd03gFAgYqtn2yK5380MIniq7x1 h1eeuSaTP9UhdxW7iDN97s6DEpyB2x3KgVmuAjxfiACtDV63X00mDuoS0Zs9NkibXDUB5ce+obH6p Y0TJdQadU5uCSKjC33yArg==; In-Reply-To: <87plx7e74o.fsf@posteo.net> (message from Philip Kaludercic on Thu, 08 Feb 2024 07:40:23 +0000) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:279608 Archived-At: > From: Philip Kaludercic > Cc: mail@daniel-mendler.de, 66554@debbugs.gnu.org, stefankangas@gmail.com, > monnier@iro.umontreal.ca > Date: Thu, 08 Feb 2024 07:40:23 +0000 > > Eli Zaretskii writes: > > >> Daniel, do have any ideas how to improve the documentation here? It > >> seems to me that the authoritative source of information on what > >> functions to compat-call is Compat itself, right? > > > > What does Compat manual say about this aspect? > > --8<---------------cut here---------------start------------->8--- > Note that Compat provides replacement functions with extended > functionality for functions that are already defined (@code{sort}, > @code{assoc}, @dots{}). These functions may have changed their > calling convention (additional optional arguments) or may have changed > their behavior. These functions must be looked up explicitly with > @code{compat-function} or called explicitly with @code{compat-call}. > We call them ``Extended Definitions''. In contrast, newly ``Added > Definitions'' can be called as usual. Thanks. I suggest to copy the above paragraph to the ELisp reference manual, and add a cross-reference to the Compat manual after it. Btw, whenever you introduce terminology in our manuals, as in ``Extended Definitions'' above, it is best to use the @dfn markup instead of literal quotes: the results look better in HTML and printed output formats.