Merge pull request #1868 from braingram/update_whats_new

Final 4.0.0 updates
asdf-format · Nov 19, 2024 · d676e11 · d676e11
2 parents b67f11b + d081c54
commit d676e11
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 7 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -14,7 +14,7 @@ build:
     pre_install:
       - git update-index --assume-unchanged docs/rtd_environment.yaml docs/conf.py
     post_install:
-      - towncrier build --keep
+      - git describe --exact-match || towncrier build --keep
 
 conda:
   environment: docs/rtd_environment.yaml

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,3 +1,35 @@
+4.0.0 (2024-11-19)
+==================
+
+Feature
+-------
+
+- Switch default ASDF standard to 1.6.0. (`#1744
+  <https://github.com/asdf-format/asdf/pull/1744>`_)
+- Raise RuntimeError if a Convert subclass supports multiple tags but doesn't
+  implement select_tag. (`#1853
+  <https://github.com/asdf-format/asdf/pull/1853>`_)
+
+
+General
+-------
+
+- Set ``memmap=False`` to default for ``asdf.open`` and ``AsdfFile.__init__``.
+  (`#1801 <https://github.com/asdf-format/asdf/pull/1801>`_)
+
+
+Removal
+-------
+
+- remove ``copy_arrays`` (replaced by ``memmap``) (`#1800
+  <https://github.com/asdf-format/asdf/pull/1800>`_)
+- Remove deprecated API. See docs for full details. (`#1852
+  <https://github.com/asdf-format/asdf/pull/1852>`_)
+- Switch default convert_unknown_ndarray_subclasses to False and issue
+  deprecation warning if it is enabled. (`#1858
+  <https://github.com/asdf-format/asdf/pull/1858>`_)
+
+
 3.5.0 (2024-10-02)
 ==================
 

diff --git a/changes/1744.feature.rst b/changes/1744.feature.rst
diff --git a/changes/1800.removal.rst b/changes/1800.removal.rst
diff --git a/changes/1801.general.rst b/changes/1801.general.rst
diff --git a/changes/1852.removal.rst b/changes/1852.removal.rst
diff --git a/changes/1853.feature.rst b/changes/1853.feature.rst
diff --git a/changes/1858.removal.rst b/changes/1858.removal.rst
diff --git a/docs/asdf/whats_new.rst b/docs/asdf/whats_new.rst
@@ -119,6 +119,22 @@ returned as lists. With asdf 4.0.0 this "implicit conversion" is
 no longer performed which allows extensions to implement converters
 for ``namedtuple`` instances.
 
+.. _whats_new_4.0.0_unknown_ndarray_subclasses:
+
+Unknown NDArray Subclasses
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In asdf 3.0.0 a config attribute was added
+`asdf.config.AsdfConfig.convert_unknown_ndarray_subclasses` that
+was enabled by default (to retain the behavior of the removed legacy
+extension that handled ndarrays).
+
+In asdf 4.0.0 this setting is disabled by default and issues a deprecation
+warning when enabled. In an upcoming version of asdf this setting will
+be removed.
+
+See :ref:`convert_unknown_ndarray_subclasses` for more details.
+
 3.0.0
 =====