branch: externals/compat
commit da9d92c288cbd73c62e7a6bd7e57f4b1ab31eb9c
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Remove :note support
---
compat-26.el | 5 +++--
compat-27.el | 5 +++--
compat-28.el | 10 ++++++----
compat-29.el | 25 +++++++++++++++----------
compat-macs.el | 3 ---
compat-tests.el | 1 -
6 files changed, 27 insertions(+), 22 deletions(-)
diff --git a/compat-26.el b/compat-26.el
index 7190bc2f68..8a56a460ab 100644
--- a/compat-26.el
+++ b/compat-26.el
@@ -637,8 +637,9 @@ NAME is a short name for the entry to be displayed while
prompting
\(if there's no room, it might be shortened).
If LONG-FORM, do a `completing-read' over the NAME elements in
-CHOICES instead."
- :note "This is a partial implementation of `read-multiple-choice', that
+CHOICES instead.
+
+NOTE: This is a partial implementation of `read-multiple-choice', that
among other things doesn't offer any help and ignores the
optional DESCRIPTION field."
(if long-form
diff --git a/compat-27.el b/compat-27.el
index cf92f03d62..7d162152ad 100644
--- a/compat-27.el
+++ b/compat-27.el
@@ -325,8 +325,9 @@ represent a JSON false value. It defaults to `:false'."
(compat-defun time-equal-p (t1 t2)
"Return non-nil if time value T1 is equal to time value T2.
-A nil value for either argument stands for the current time."
- :note "This function is not as accurate as the actual `time-equal-p'."
+A nil value for either argument stands for the current time.
+
+NOTE: This function is not as accurate as the actual `time-equal-p'."
(cond
((eq t1 t2))
((and (consp t1) (consp t2))
diff --git a/compat-28.el b/compat-28.el
index aa5945e0ce..f9d422c6a6 100644
--- a/compat-28.el
+++ b/compat-28.el
@@ -51,8 +51,9 @@ The optional START-POS argument says where to start searching
in
HAYSTACK and defaults to zero (start at the beginning).
It must be between zero and the length of HAYSTACK, inclusive.
-Case is always significant and text properties are ignored."
- :note "Prior to Emacs 27 `string-match' has issues handling
+Case is always significant and text properties are ignored.
+
+NOTE: Prior to Emacs 27 `string-match' has issues handling
multibyte regular expressions. As the compatibility function
for `string-search' is implemented via `string-match', these
issues are inherited."
@@ -123,8 +124,9 @@ FACTOR determines what \"enough\" means here: If FACTOR is a
positive number N, it means to run GC if more than 1/Nth of the
allocations needed to trigger automatic allocation took place.
Therefore, as N gets higher, this is more likely to perform a GC.
-Returns non-nil if GC happened, and nil otherwise."
- :note "For releases of Emacs before version 28, this function will do
nothing."
+Returns non-nil if GC happened, and nil otherwise.
+
+NOTE: For releases of Emacs before version 28, this function will do nothing."
;; Do nothing
nil)
diff --git a/compat-29.el b/compat-29.el
index 67cfd207e8..2fc03dbc40 100644
--- a/compat-29.el
+++ b/compat-29.el
@@ -762,8 +762,9 @@ KEY is a string that satisfies `key-valid-p'.
Note that if KEY has a local binding in the current buffer,
that local binding will continue to shadow any global binding
-that you make with this function."
- :note "The compatibility version of is not a command."
+that you make with this function.
+
+NOTE: The compatibility version is not a command."
(compat--keymap-set (current-global-map) key command))
;;* UNTESTED
@@ -775,8 +776,9 @@ a symbol naming an interactively-callable function.
KEY is a string that satisfies `key-valid-p'.
The binding goes in the current buffer's local map, which in most
-cases is shared with all other buffers in the same major mode."
- :note "The compatibility version of is not a command."
+cases is shared with all other buffers in the same major mode.
+
+NOTE: The compatibility version is not a command."
(let ((map (current-local-map)))
(unless map
(use-local-map (setq map (make-sparse-keymap))))
@@ -788,8 +790,9 @@ cases is shared with all other buffers in the same major
mode."
KEY is a string that satisfies `key-valid-p'.
If REMOVE (interactively, the prefix arg), remove the binding
-instead of unsetting it. See `keymap-unset' for details."
- :note "The compatibility version of is not a command."
+instead of unsetting it. See `keymap-unset' for details.
+
+NOTE: The compatibility version is not a command."
(compat--keymap-unset (current-global-map) key remove))
;;* UNTESTED
@@ -798,8 +801,9 @@ instead of unsetting it. See `keymap-unset' for details."
KEY is a string that satisfies `key-valid-p'.
If REMOVE (interactively, the prefix arg), remove the binding
-instead of unsetting it. See `keymap-unset' for details."
- :note "The compatibility version of is not a command."
+instead of unsetting it. See `keymap-unset' for details.
+
+NOTE: The compatibility version is not a command."
(when (current-local-map)
(compat--keymap-unset (current-local-map) key remove)))
@@ -929,8 +933,9 @@ This function's return values are the same as those of
`keymap-lookup'
If optional argument ACCEPT-DEFAULT is non-nil, recognize default
bindings; see the description of `keymap-lookup' for more details
-about this."
- :note "The compatibility version of is not a command."
+about this.
+
+NOTE: The compatibility version is not a command."
(compat--keymap-lookup (current-global-map) keys accept-default))
;;* UNTESTED
diff --git a/compat-macs.el b/compat-macs.el
index 7943847255..8c81b4dfc2 100644
--- a/compat-macs.el
+++ b/compat-macs.el
@@ -69,9 +69,6 @@ ignored:
- :realname :: Manual specification of a \"realname\" to use for
the compatibility definition (symbol).
-- :notes :: Additional notes that a developer using this
- compatibility function should keep in mind.
-
- :prefix :: Add a `compat-' prefix to the name, and define the
compatibility code unconditionally.
diff --git a/compat-tests.el b/compat-tests.el
index b5deed0cbc..5766d06253 100644
--- a/compat-tests.el
+++ b/compat-tests.el
@@ -70,7 +70,6 @@ DEF-FN, INSTALL-FN, CHECK-FN, ATTR and TYPE."
(put ',realname 'compat-version ,version)
(put ',realname 'compat-min-version ,min-version)
(put ',realname 'compat-max-version ,max-version)
- (put ',realname 'compat-doc ,(plist-get attr :note))
,(funcall def-fn realname version)
,(and check
`(,@check
