[elpa] externals/compat 50b117331a: compat-function: Expand docstring

[ELPA Syncer]

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

    compat-function: Expand docstring
---
 compat.el | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/compat.el b/compat.el
index 9e413de991..ca836d65c7 100644
--- a/compat.el
+++ b/compat.el
@@ -51,7 +51,12 @@
   "Return compatibility function symbol for FUN.
 
 If the Emacs version provides a sufficiently recent version of
-FUN, the symbol FUN is returned itself."
+FUN, the symbol FUN is returned itself. Otherwise the macro
+returns the symbol of a compatibility function which supports the
+behavior and calling convention of the current stable Emacs
+version. For example Compat 29.1 will provide compatibility
+functions which implement the behavior and calling convention of
+Emacs 29.1."
   (let ((compat (intern (format "compat--%s" fun))))
     `#',(if (fboundp compat) compat fun)))