Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deprecate copy_arrays with warning #1797

Merged
merged 16 commits into from
Aug 12, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add caution note to README
zacharyburnett committed Aug 12, 2024
commit 479688535f8ee7c8a6489f1a91e9ee5c3a989162
7 changes: 7 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -185,6 +185,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``.
zacharyburnett marked this conversation as resolved.
Show resolved Hide resolved

To get a quick overview of the data stored in the file, use the top-level
`AsdfFile.info()` method: