From 76588bb26c17546dbe0350c7398d8067172fb045 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Mon, 15 Jul 2024 14:49:37 -0400 Subject: [PATCH] add caution note to README --- README.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.rst b/README.rst index 775fb4a7b..b9fc061b1 100644 --- a/README.rst +++ b/README.rst @@ -189,6 +189,13 @@ The `open` function also works as a context handler: with asdf.open("example.asdf") as af: ... +.. warning:: + The ``copy_arrays`` argument of `asdf.open()` and `AsdfFile` is deprecated, + and will be removed in ASDF 4.0. It is replaced by the more-explicitly-named + ``memmap`` argument as the inverse of ``copy_arrays`` + (``memmap == not copy_arrays``). Using ``copy_arrays`` will work for now, but + give an ``AsdfWarning``. + To get a quick overview of the data stored in the file, use the top-level `AsdfFile.info()` method: