docs(CHANGES): Note testing of examples

cihai · Dec 10, 2023 · 08a023a · 08a023a
1 parent 2ed0a2e
commit 08a023a
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/CHANGES b/CHANGES
@@ -38,6 +38,24 @@ $ pip install --user --upgrade --pre unihan-db
 
 - Add docstrings to functions, methods, classes, and packages (#322)
 
+### Tests
+
+- Test `examples/` (#324)
+
+  These are high-level integrative tests of the same example code the project
+  uses in documentation.
+
+  This brings code coverage from 69.77 to 93.92%.
+
+  **A note on test times**
+
+  - CI (GitHub Actions) can take 5-6 minutes per test
+
+    This may change in future cases when UNIHAN is cached.
+
+  - Initial (cold) py.tests on local environments won't be cached and will take
+    similar times. Subsequent tests can be <0.6 seconds.
+
 ## unihan-db 0.13.0 (2023-11-19)
 
 ### Packaging