|
| 1 | +# Changelog |
| 2 | + |
| 3 | +## v1.6 (2024-12-17) |
| 4 | + |
| 5 | +- Fix a collection issue, where the DocTestFinder was missing docstrings of data |
| 6 | + descriptors. This is a workaround for an upstream issue, |
| 7 | + https://github.com/python/cpython/issues/127962. The patch by Matti Picus. |
| 8 | +- Fix a collection issue, where the DocTestFinder was missing docstrings of public |
| 9 | + methods inherited from a private superclass. This was causing issues with some |
| 10 | + SciPy docstrings not being checked. |
| 11 | + |
| 12 | + |
| 13 | +## v1.5.1 (2024-12-09) |
| 14 | + |
| 15 | +- Improve handling of NumPy's abbreviation of large arrays: starting from version 2.2, |
| 16 | + NumPy displays the size of an array via a `shape=` argument: |
| 17 | + |
| 18 | +``` |
| 19 | +>>> np.ones(10_000) |
| 20 | +>>> array([1., 1., 1., ..., 1., 1., 1.], shape=(10000,)) |
| 21 | +``` |
| 22 | + |
| 23 | + We now ignore the `shape=` part on NumPy < 2.2 and check the value on newer versions. |
| 24 | + |
| 25 | + |
| 26 | +# v1.4 (2024-09-23) |
| 27 | + |
| 28 | +- Add a `strict_check` configuration flag to decide whether to require matching dtypes |
| 29 | + or rely on NumPy's lax definition of equality: |
| 30 | + |
| 31 | +``` |
| 32 | +>>> np.float64(3) == 3 |
| 33 | +True |
| 34 | +``` |
| 35 | + |
| 36 | +- Allow placing the `# may vary` modifier at either the source or the output of the doctest. |
| 37 | +- Fix an issue with `local_resourses`, tests opening external files. The patch is from |
| 38 | + Sheila Kahwai. |
| 39 | + |
| 40 | + |
| 41 | +## v1.3 (2024-06-22) |
| 42 | + |
| 43 | +- Fix the interaction with pytest assertion rewriting. |
| 44 | + |
| 45 | +## v1.2 (2024-06-08) |
| 46 | + |
| 47 | +- More robust handling of printed numpy arrays in doctests. |
| 48 | +- More robust checking of docstrings of deprecated functions. |
| 49 | +- Fix an issue with handling lists/tuples: previously, the checker did not |
| 50 | + distinguish lists from tuples or other array-likes. The patch is from Luiz Eduardo Amaral. |
| 51 | +- Fix an issue with the checker missing items for lists/tuples of mismatched lengths |
| 52 | + The patch is from Luiz Eduardo Amaral. |
| 53 | + |
| 54 | + |
| 55 | +## v1.1 (2024-05-15) |
| 56 | + |
| 57 | +Implementation the pytest plugin layer. The bulk of work done by Sheila Kahwai. |
| 58 | +The preferred way to run the doctesting is now via pytest. |
| 59 | + |
| 60 | + |
| 61 | +## v1.0 (2023-07-13) |
| 62 | + |
| 63 | +This is the first release of a standalone package, following the extraction of the |
| 64 | +core functionality from SciPy's and NumPy's `refguide-check` utilities. |
0 commit comments