[python-hdf5storage] 67/84: Updated documentation for version 0.1.8

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to annotated tag 0.1.10
in repository python-hdf5storage.

commit d91c5fbe2ac18645ae3453e4bb2db59329819ba3
Author: Freja Nordsiek <fnordsie at gmail.com>
Date:   Sat Aug 22 14:06:47 2015 -0400

    Updated documentation for version 0.1.8
---
 README.rst                    | 19 ++++++++++++++++++-
 doc/source/storage_format.rst | 10 +++++++++-
 2 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index e1fcefe..ff4d89d 100644
--- a/README.rst
+++ b/README.rst
@@ -165,6 +165,8 @@ np.recarray      0.1      structured np.ndarray       [9]_ [10]_   0.1 [9]_
        non-ASCII characters in which case a ``NotImplementedError`` is
        thrown). Otherwise, it is just written as ``np.bytes_``.
 .. [7] All keys must be ``str`` in Python 3 or ``unicode`` in Python 2.
+       They cannot have null characters (``'\x00'``) or forward slashes
+       (``'/'``) in them.
 .. [8] ``np.float16`` are not supported for h5py versions before
        ``2.2``.
 .. [9] Container types are only supported if their underlying dtype is
@@ -174,7 +176,9 @@ np.recarray      0.1      structured np.ndarray       [9]_ [10]_   0.1 [9]_
         Datasets holding its fields (either the values directly, or as
         an HDF5 Reference array to the values for the different elements
         of the data). Can only be written as an HDF5 COMPOUND type if
-        none of its field are of dtype ``'object'``.
+        none of its field are of dtype ``'object'``. Field names cannot
+        have null characters (``'\x00'``) and, when writing as an HDF5
+        GROUP, forward slashes (``'/'``) in them.
 .. [11] Structured ``np.ndarray`` s with no elements, when written like a
         structure, will not be read back with the right dtypes for their
         fields (will all become 'object').
@@ -209,6 +213,19 @@ canonical empty  0.1      ``np.float64([])``
 Versions
 ========
 
+0.1.8. Bugfix release fixing the following two bugs.
+       * Issue #21. Fixed bug where the ``'MATLAB_class'`` Attribute is
+         not set when writing ``dict`` types when writing MATLAB
+         metadata.
+       * Issue #22. Fixed bug where null characters (``'\x00'``) and
+         forward slashes (``'/'``) were allowed in ``dict`` keys and the
+         field names of structured ``np.ndarray`` (except that forward
+         slashes are allowed when the
+         ``structured_numpy_ndarray_as_struct`` is not set as is the
+         case when the ``matlab_compatible`` option is set). These
+         cause problems for the ``h5py`` package and the HDF5 library.
+         ``NotImplementedError`` is now thrown in these cases.
+
 0.1.7. Bugfix release with an added compatibility option and some added test code. Did the following.
        * Fixed an issue reading variables larger than 2 GB in MATLAB
          MAT v7.3 files when no explicit variable names to read are
diff --git a/doc/source/storage_format.rst b/doc/source/storage_format.rst
index 932a744..f4fcc16 100644
--- a/doc/source/storage_format.rst
+++ b/doc/source/storage_format.rst
@@ -120,6 +120,8 @@ np.recarray      0.1      structured np.ndarray [9]_            Dataset or Group
        characters in which case a ``NotImplementedError`` is raised.
        Otherwise, it is just written as ``np.bytes_``.
 .. [7] All keys must be ``str`` in Python 3 or ``unicode`` in Python 2.
+       They cannot have null characters (``'\x00'``) or forward slashes
+       (``'/'``) in them.
 .. [8] ``np.float16`` are not supported for h5py versions before
        ``2.2``.
 .. [9] If it doesn't have any fields in its dtype or if
@@ -128,7 +130,8 @@ np.recarray      0.1      structured np.ndarray [9]_            Dataset or Group
        converted and is written as is as a Dataset. Otherwise, it
        is written as a Group with its the contents of its individual
        fields written as Datasets within the Group having the fields as
-       names.
+       names. Field names cannot have null characters (``'\x00'``) and,
+       when writing as an GROUP, forward slashes (``'/'``) in them.
 
 
 Attributes
@@ -385,6 +388,11 @@ all of those elements is written as a Dataset under the field name in
 the Groups. Othewise, it is written as is as a Dataset that is an
 HDF5 COMPOUND type.
 
+.. warning::
+
+   Field names cannot have null characters (``'\x00'``) and, when
+   writing as an HDF5 GROUP, forward slashes (``'/'``) in them.
+
 
 .. warning::
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-hdf5storage.git