Merge pull request #193 from scipy/changelog

DOC: add changelog

Author: ev-br

docs/changelog.md

@@ -0,0 +1,74 @@
+# Changelog
+
+## v1.7 (2025-04-04)
+
+- Support python 3.13. The patch by Ben Beasley.
+  Starting from python 3.13, the standard library `doctest.DoctestRunner` tracks the
+  number of skipped doctests, in addition to the counts of attempted and failed
+  doctests. We track this change, thus both the return value of `DTRunner.run` and
+  `DTRunner.get_history` contain this count on python 3.13+ and do not contain it on
+  prior python versions.
+
+
+## v1.6 (2024-12-17)
+
+- Fix a collection issue, where the DocTestFinder was missing docstrings of data
+  descriptors. This is a workaround for an upstream issue,
+  https://github.com/python/cpython/issues/127962. The patch by Matti Picus.
+- Fix a collection issue, where the DocTestFinder was missing docstrings of public
+  methods inherited from a private superclass. This was causing issues with some
+  SciPy docstrings not being checked.
+
+
+## v1.5.1 (2024-12-09)
+
+- Improve handling of NumPy's abbreviation of large arrays: starting from version 2.2,
+  NumPy displays the size of an array via a `shape=` argument:
+
+```
+>>> np.ones(10_000)
+>>> array([1., 1., 1., ..., 1., 1., 1.], shape=(10000,))
+```
+
+  We now ignore the `shape=` part on NumPy < 2.2 and check the value on newer versions.
+
+
+# v1.4 (2024-09-23)
+
+- Add a `strict_check` configuration flag to decide whether to require matching dtypes
+  or rely on NumPy's lax definition of equality: 
+
+```
+>>> np.float64(3) == 3
+True
+```
+
+- Allow placing the `# may vary` modifier at either the source or the output of the doctest.
+- Fix an issue with `local_resourses`, tests opening external files. The patch is from
+  Sheila Kahwai.
+
+
+## v1.3 (2024-06-22)
+
+- Fix the interaction with pytest assertion rewriting.
+
+## v1.2 (2024-06-08)
+
+- More robust handling of printed numpy arrays in doctests.
+- More robust checking of docstrings of deprecated functions.
+- Fix an issue with handling lists/tuples: previously, the checker did not
+  distinguish lists from tuples or other array-likes. The patch is from Luiz Eduardo Amaral.
+- Fix an issue with the checker missing items for lists/tuples of mismatched lengths
+  The patch is from Luiz Eduardo Amaral.
+
+
+## v1.1 (2024-05-15)
+
+Implementation the pytest plugin layer. The bulk of work done by Sheila Kahwai.
+The preferred way to run the doctesting is now via pytest.
+
+
+## v1.0 (2023-07-13)
+
+This is the first release of a standalone package, following the extraction of the
+core functionality from SciPy's and NumPy's `refguide-check` utilities.

docs/index.md

@@ -8,4 +8,5 @@
 Home <self>
 implementation.md
 plugin.md
+changelog.md
 ```

scipy_doctest/__init__.py

@@ -3,7 +3,7 @@
 """
 
 
-__version__ = "1.7dev0"
+__version__ = "1.7"
 
 try:
     # register internal modules with pytest; obscure errors galore otherwise