emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/compat b1e2a804a4 1/2: Improve manual


From: ELPA Syncer
Subject: [elpa] externals/compat b1e2a804a4 1/2: Improve manual
Date: Wed, 1 Feb 2023 04:57:24 -0500 (EST)

branch: externals/compat
commit b1e2a804a453ee93713a5a4ad8c45a134dffbcb8
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>

    Improve manual
---
 compat.texi | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/compat.texi b/compat.texi
index 2867d350e7..2e013ccd26 100644
--- a/compat.texi
+++ b/compat.texi
@@ -223,7 +223,7 @@ macro @code{setopt} is such an example.
 
 @item
 The added or extended function belongs to the ``application level''
-and not the ``library level''.  Features which not preloaded often
+and not the ``library level''.  Features which are not preloaded often
 belong to the ``application level''.  Application examples are
 programming modes or modes like Dired, IRC and Gnus.  If these modes
 are extended with new functions, these are not ported back.
@@ -231,12 +231,17 @@ are extended with new functions, these are not ported 
back.
 @item
 An existing function or macro was extended by some new functionality.
 To support these cases, the function or macro would have to be
-advised. Since this is invasive and adds significant overhead, even
+advised.  Since this is invasive and adds significant overhead, even
 when the new feature is not used, Compat does not use advices.  As a
 compromise, compatibility functions and macros with a changed calling
 convention or behavior can be accessed via the @code{compat-function}
-and @code{compat-call} macros. An example is the function
-@code{plist-get}.
+and @code{compat-call} macros.  In this manual we call such
+definitions ``Extended Definitions''. An example is the function
+@code{plist-get}.  Note that extended functions are subject to closer
+scrutiny, since their usage is not completely painless thanks to
+@code{compat-call}.  If a particular extended function does not see
+much usage or the extension yields only marginal benefits, we may not
+provide it as part of Compat.
 
 @item
 Bug fixes are usually not ported back as part of Compat.  Sometimes



reply via email to

[Prev in Thread] Current Thread [Next in Thread]