Skip to content

Commit c097f2d

Browse files
committed
Make reference to Storage docs for mmap params
1 parent 81ebcbe commit c097f2d

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

doc/reference/storage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _CompStorParams:
2+
13
Compression, decompression and storage parameters
24
=================================================
35

src/blosc2/schunk.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1441,13 +1441,19 @@ def open(
14411441
The path where the :ref:`SChunk` (or :ref:`NDArray`)
14421442
is stored. If it is a remote array, a :ref:`URLPath` must be passed.
14431443
mode: str, optional
1444-
The open mode.
1444+
Persistence mode: 'r' means read only (must exist);
1445+
'a' means read/write (create if it doesn't exist);
1446+
'w' means create (overwrite if it exists). Default is 'a'.
14451447
offset: int, optional
14461448
An offset in the file where super-chunk or array data is located
14471449
(e.g. in a file containing several such objects).
14481450
kwargs: dict, optional
1449-
mmap_mode: The memory mapping mode.
1450-
initial_mapping_size: The initial size of the memory mapping.
1451+
mmap_mode: str, optional
1452+
If set, the file will be memory-mapped instead of using the default
1453+
I/O functions and the `mode` argument will be ignored.
1454+
For more info, see :class:`blosc2.Storage`.
1455+
initial_mapping_size: int, optional
1456+
The initial size of the memory mapping. For more info, see :class:`blosc2.Storage`.
14511457
cparams: dict
14521458
A dictionary with the compression parameters, which are the same that can be
14531459
used in the :func:`~blosc2.compress2` function.

0 commit comments

Comments
 (0)