Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Brett Graham <[email protected]>
  • Loading branch information
zacharyburnett and braingram authored Jul 17, 2024
1 parent 4ad6b71 commit 85e1f2a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,10 @@ The `open` function also works as a context handler:
.. 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``.
and will be removed in ASDF 4.0. It is replaced by ``memmap``, which
is the opposite of ``copy_arrays`` (``memmap == not copy_arrays``).
In ASDF 4.0, ``memmap`` will default to ``False``, which means arrays
will no longer be memory-mapped by default.

To get a quick overview of the data stored in the file, use the top-level
`AsdfFile.info()` method:
Expand Down
4 changes: 2 additions & 2 deletions asdf/_asdf.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ def __init__(
When `True`, when reading files, attempt to memmap underlying data
arrays when possible. When set, this argument will override
``copy_arrays``. The default will change to ``False`` in an upcoming
ASDF version.
ASDF version. At the moment the default is ``True``.
lazy_load : bool, optional
When `True` and the underlying file handle is seekable, data
Expand Down Expand Up @@ -1673,7 +1673,7 @@ def open_asdf(
When `True`, when reading files, attempt to memmap underlying data
arrays when possible. When set, this argument will override
``copy_arrays``. The default will change to ``False`` in an upcoming
ASDF version.
ASDF version. At the moment the default is ``True``.
lazy_load : bool, optional
When `True` and the underlying file handle is seekable, data
Expand Down

0 comments on commit 85e1f2a

Please sign in to comment.