[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#66554: [PATCH] Add the public API of Compat to the core
From: |
Daniel Mendler |
Subject: |
bug#66554: [PATCH] Add the public API of Compat to the core |
Date: |
Thu, 08 Feb 2024 11:47:21 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) |
Eli Zaretskii <eliz@gnu.org> writes:
>> From: Philip Kaludercic <philipk@posteo.net>
>> 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 <eliz@gnu.org> 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.
Thanks for mentioning @dfn. When we added the concept of ``Extended
Definitions'' to the Compat manual I was wondering if there is a better
way to make it stand out more. I will update the Compat manual
accordingly.
Daniel
- bug#66554: [PATCH] Add the public API of Compat to the core, (continued)
- bug#66554: [PATCH] Add the public API of Compat to the core, Philip Kaludercic, 2024/02/02
- bug#66554: [PATCH] Add the public API of Compat to the core, Eli Zaretskii, 2024/02/02
- bug#66554: [PATCH] Add the public API of Compat to the core, Philip Kaludercic, 2024/02/06
- bug#66554: [PATCH] Add the public API of Compat to the core, Eli Zaretskii, 2024/02/06
- bug#66554: [PATCH] Add the public API of Compat to the core, Philip Kaludercic, 2024/02/06
- bug#66554: [PATCH] Add the public API of Compat to the core, Philip Kaludercic, 2024/02/07
- bug#66554: [PATCH] Add the public API of Compat to the core, Daniel Mendler, 2024/02/07
- bug#66554: [PATCH] Add the public API of Compat to the core, Eli Zaretskii, 2024/02/07
- bug#66554: [PATCH] Add the public API of Compat to the core, Philip Kaludercic, 2024/02/08
- bug#66554: [PATCH] Add the public API of Compat to the core, Eli Zaretskii, 2024/02/08
- bug#66554: [PATCH] Add the public API of Compat to the core,
Daniel Mendler <=
- bug#66554: [PATCH] Add the public API of Compat to the core, Philip Kaludercic, 2024/02/10
- bug#66554: [PATCH] Add the public API of Compat to the core, Eli Zaretskii, 2024/02/10
- bug#66554: [PATCH] Add the public API of Compat to the core, Philip Kaludercic, 2024/02/10
- bug#66554: [PATCH] Add the public API of Compat to the core, Eli Zaretskii, 2024/02/10
- bug#66554: [PATCH] Add the public API of Compat to the core, Daniel Mendler, 2024/02/10
- bug#66554: [PATCH] Add the public API of Compat to the core, Daniel Mendler, 2024/02/10
- bug#66554: [PATCH] Add the public API of Compat to the core, Eli Zaretskii, 2024/02/10
- bug#66554: [PATCH] Add the public API of Compat to the core, Eli Zaretskii, 2024/02/10
- bug#66554: [PATCH] Add the public API of Compat to the core, Daniel Mendler, 2024/02/10
- bug#66554: [PATCH] Add the public API of Compat to the core, Eli Zaretskii, 2024/02/10