diff options
Diffstat (limited to 'doc/source/Tutorials/io.rst')
| -rw-r--r-- | doc/source/Tutorials/io.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/source/Tutorials/io.rst b/doc/source/Tutorials/io.rst index 139ad2d..369e5ad 100644 --- a/doc/source/Tutorials/io.rst +++ b/doc/source/Tutorials/io.rst @@ -31,7 +31,8 @@ Regarding HDF5 files, the de-facto standard for reading them in Python is to use the *h5py* library. *silx* tries to address this situation by providing a unified way to read all -data formats supported at the ESRF. Today, HDF5 is the preffered format to store +data formats supported at the ESRF. +Today, HDF5 is the preffered format to store data for many scientific institutions, including most synchrotrons. So it was decided to provide tools for reading data that mimic the *h5py* library's API. @@ -100,7 +101,7 @@ The objects defined in `silx.io` implement a subset of these attributes and meth - :attr:`filename`: Name of the file on disk. - :attr:`mode`: String indicating if the file is open in read mode ("r") or write mode ("w"). :meth:`silx.io.open` always returns objects in read mode. - - :meth:`close`: Close this file. All open objects will become invalid. + - :meth:`close`: Close this file. All child objects, groups and datasets, will become invalid. The :attr:`parent` of a file is `None`, and its :attr:`name` is an empty string. |