branch: externals/compat
commit aea1ccfa92f4b61911e37d8b0bb011807dd451fe
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Update documentation, test coverage is now 100%.
---
NEWS.org | 2 +-
compat-tests.el | 16 +++++++---------
compat.texi | 10 ++++------
3 files changed, 12 insertions(+), 16 deletions(-)
diff --git a/NEWS.org b/NEWS.org
index e777c9b5c0..f80257ccb7 100644
--- a/NEWS.org
+++ b/NEWS.org
@@ -2,7 +2,7 @@
* Development of "Compat" Version 29.1.2.0
-- Add tests.
+- All compatibility functions are covered by tests!
- Add links from compatibility definitions to tests.
- BREAKING: Drop JSON parsing support (libjansson API).
- BREAKING: Drop ~null-device~.
diff --git a/compat-tests.el b/compat-tests.el
index 793eeed5a4..4da2e121d9 100644
--- a/compat-tests.el
+++ b/compat-tests.el
@@ -19,15 +19,13 @@
;; Tests for compatibility functions from compat.el.
;;
-;; Note that not all functions have tests yet. Grep the Compat code for
-;; <UNTESTED> labels. If you intend to use a function, which doesn't have
-;; tests yet, please contribute tests here. NO GUARANTEES ARE MADE FOR
-;; FUNCTIONS WITHOUT TESTS.
-
-;; Functions which are tested are marked with a link to the testsuite. The
-;; link type `compat-tests' must be registered first by evaluating the
-;; following code. If you intend to work on the test suite you can add
-;; this code to your init.el.
+;; Note that all functions are covered by tests. When new functions are
+;; added to Compat, they must come with test coverage!
+
+;; Functions are marked with a link to the testsuite. The link type
+;; `compat-tests' must be registered first by evaluating the following
+;; code. If you intend to work on the test suite you can add this code to
+;; your init.el.
;;
;; (require 'ol)
;; (org-link-set-parameters
diff --git a/compat.texi b/compat.texi
index 65a39ec10a..433bb723e1 100644
--- a/compat.texi
+++ b/compat.texi
@@ -166,12 +166,10 @@ compatibility functions.
If you intend to use a compatibility function in your code it is
strongly recommended that you check the tests in
-@file{compat-tests.el}. Alternatively grep the Compat code for
-<UNTESTED> labels. There you will find the supported calling
-convention, which is guaranteed to work on the supported Emacs
-versions. We ensure this using continuous integration. If a function
-is not tested yet in @file{compat-tests.el} NO GUARANTEES CAN BE MADE.
-You are invited to contribute tests in this case
+@file{compat-tests.el} to see the supported calling conventions, which
+are guaranteed to work on the supported Emacs versions. We ensure this
+using continuous integration. All functions provided by Compat are
+covered by the testsuite.
It is recommended to subscribe to the
@uref{https://lists.sr.ht/~pkal/compat-announce, compat-announce}
