Skip to content

Commit

Permalink
add caution note to README
Browse files Browse the repository at this point in the history
  • Loading branch information
zacharyburnett committed Jul 15, 2024
1 parent 0862676 commit 76588bb
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 76588bb

Please sign in to comment.