Skip to content

Commit 0c4c492

Browse files
committed
doco edits
1 parent 2f95d82 commit 0c4c492

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/tutorial.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Tutorial
55

66
Zarr provides classes and functions for working with N-dimensional
77
arrays that behave like NumPy arrays but whose data is divided into
8-
chunks and compressed. If you are already familiar with HDF5 datasets
8+
chunks and compressed. If you are already familiar with HDF5
99
then Zarr arrays provide similar functionality, but with some
1010
additional flexibility.
1111

@@ -98,7 +98,7 @@ enabling persistence of data between sessions. For example::
9898

9999
The array above will store its configuration metadata and all
100100
compressed chunk data in a directory called 'example.zarr' relative to
101-
the current working directory. The :func:`zarr.creation.open` function
101+
the current working directory. The :func:`zarr.creation.open_array` function
102102
provides a convenient way to create a new persistent array or continue
103103
working with an existing array. Note that there is no need to close an
104104
array, and data are automatically flushed to disk whenever an array is
@@ -113,7 +113,7 @@ data, e.g.::
113113

114114
Check that the data have been written and can be read again::
115115

116-
>>> z2 = zarr.open('example.zarr', mode='r')
116+
>>> z2 = zarr.open_array('example.zarr', mode='r')
117117
>>> z2
118118
Array((10000, 10000), int32, chunks=(1000, 1000), order=C)
119119
nbytes: 381.5M; nbytes_stored: 1.9M; ratio: 204.5; initialized: 100/100
@@ -413,7 +413,7 @@ Groups can also contain arrays, e.g.::
413413

414414
Arrays are known as "datasets" in HDF5 terminology. For compatibility with
415415
h5py, Zarr groups also implement the :func:`zarr.hierarchy.Group.create_dataset`
416-
method, e.g.::
416+
and :func:`zarr.hierarchy.Group.require_dataset` methods, e.g.::
417417

418418
>>> z = bar_group.create_dataset('quux', shape=(10000, 10000),
419419
... chunks=(1000, 1000), dtype='i4',
@@ -521,7 +521,7 @@ Storage alternatives
521521
~~~~~~~~~~~~~~~~~~~~
522522

523523
Zarr can use any object that implements the ``MutableMapping`` interface as
524-
the store for an array.
524+
the store for a group or an array.
525525

526526
Here is an example storing an array directly into a Zip file::
527527

@@ -612,7 +612,7 @@ to find a compromise, e.g.::
612612

613613
If you are feeling lazy, you can let Zarr guess a chunk shape for your data,
614614
although please note that the algorithm for guessing a chunk shape is based on
615-
simple heuristics and may by far from optimal. E.g.::
615+
simple heuristics and may be far from optimal. E.g.::
616616

617617
>>> z4 = zarr.zeros((10000, 10000), dtype='i4')
618618
>>> z4.chunks

0 commit comments

Comments
 (0)