Skip to content

Commit 2b2a935

Browse files
committed
Add clarification about unsupported mode in docs of blosc.open
1 parent c097f2d commit 2b2a935

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/blosc2/schunk.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1451,7 +1451,10 @@ def open(
14511451
mmap_mode: str, optional
14521452
If set, the file will be memory-mapped instead of using the default
14531453
I/O functions and the `mode` argument will be ignored.
1454-
For more info, see :class:`blosc2.Storage`.
1454+
For more info, see :class:`blosc2.Storage`. Please note that the `w+` mode, which
1455+
can be used to create new files, is not supported here since only existing files
1456+
can be opened. You can use :func:`SChunk.__init__ <blosc2.schunk.SChunk.__init__>`
1457+
to create new files.
14551458
initial_mapping_size: int, optional
14561459
The initial size of the memory mapping. For more info, see :class:`blosc2.Storage`.
14571460
cparams: dict

0 commit comments

Comments
 (0)