From c06838c576d48e4bb1d8893b6971b1f3b42db7bb Mon Sep 17 00:00:00 2001 From: Daniel D'Avella Date: Wed, 14 Nov 2018 21:59:38 -0500 Subject: [PATCH] Update What's New for 2.2.0 release --- docs/asdf/changes.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/asdf/changes.rst b/docs/asdf/changes.rst index e006f1073..5bb267f26 100644 --- a/docs/asdf/changes.rst +++ b/docs/asdf/changes.rst @@ -4,6 +4,30 @@ Changes ******* +What's New in ASDF 2.2? +======================= + +ASDF 2.2 contains several API changes, although backwards compatibilty is +preserved for now. The most significant changes are: + +* The function `AsdfFile.open` has been deprecated in favor of `asdf.open`. + It will be removed entirely in the 3.0 release. More intelligent file mode + handling has been added to `asdf.open`. Files that are opened in read-only + mode with `asdf.open` now explicitly block writes to memory-mapped arrays. + This may cause problems for some existing code, but any such code was + accessing these arrays in an unsafe manner, so backwards compatibility for + this case is not provided. The old mode handling behavior is retained for now + in `AsdfFile.open`. + +* It is now possible to disable lazy loading of internal arrays. This is useful + when the `AsdfFile` was opened using another open file. With lazy loading, it + is possible to close the original file but still retain access to the array + data. + +* There is a new warning `AsdfConversionWarning` that occurs when failing to + convert nodes in the ASDF tree into custom tagged types. This makes it easier + for users to filter specifically for this failure case. + What's New in ASDF 2.1? =======================