Skip to content

Commit

Permalink
DOC: rephrase writeup of memmap changes
Browse files Browse the repository at this point in the history
Fix a little grammatical error and expand the text on mmap changes.
  • Loading branch information
matthew-brett committed Apr 6, 2016
1 parent 537d35c commit 5da8609
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions doc/release/1.12.0-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,10 +183,14 @@ methods in this module are called with keyword arguments instead.

Operations on np.memmap objects return numpy arrays in most cases
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Previously operations on a memmap (e.g. adding 1 to it) object would
misleadingly return a memmap instance even if the result was actually
not memmapped. Also reduction of a memmap (e.g. ``.sum(axis=None``)
return a numpy scalar instead of a 0d memmap.
Previously operations on a memmap object would misleadingly return a memmap
instance even if the result was actually not memmapped. For example,
``arr + 1`` or ``arr + arr`` would return memmap instances, although no memory
from the output array is memmaped. Version 1.12 returns ordinary numpy arrays
from these operations.

Also, reduction of a memmap (e.g. ``.sum(axis=None``) now returns a numpy
scalar instead of a 0d memmap.

Deprecations
============
Expand Down

0 comments on commit 5da8609

Please sign in to comment.