[python-hdf5storage] 117/152: Updated documentation.

[Ghislain Vaillant]

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

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

commit 3b355b6c5d60f38d0ae7d1b3e5daef5762776c3d
Author: Freja Nordsiek <fnordsie at gmail.com>
Date:   Thu Feb 13 21:49:35 2014 -0500

    Updated documentation.
---
 doc/source/hdf5storage.Marshallers.rst |  9 ++++++++-
 doc/source/storage_format.rst          | 10 +++++++++-
 2 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/doc/source/hdf5storage.Marshallers.rst b/doc/source/hdf5storage.Marshallers.rst
index 9ec2197..c984250 100644
--- a/doc/source/hdf5storage.Marshallers.rst
+++ b/doc/source/hdf5storage.Marshallers.rst
@@ -7,6 +7,7 @@ hdf5storage.Marshallers
 
 .. autosummary::
 
+   write_object_array
    TypeMarshaller
    NumpyScalarArrayMarshaller
    PythonScalarMarshaller
@@ -17,6 +18,12 @@ hdf5storage.Marshallers
    PythonTupleSetDequeMarshaller
 
 
+write_object_array
+------------------
+
+.. autofunction:: write_object_array
+
+
 TypeMarshaller
 --------------
 
@@ -80,7 +87,7 @@ NumpyScalarArrayMarshaller
    .. autoinstanceattribute:: NumpyScalarArrayMarshaller.matlab_classes
       :annotation: = ['logical', 'char', 'single', 'double', 'uint8',
 	              'uint16', 'uint32', 'uint64', 'int8', 'int16',
-                      'int32', 'int64', 'cell']
+                      'int32', 'int64', 'cell', 'canonical empty']
 
 
 PythonScalarMarshaller
diff --git a/doc/source/storage_format.rst b/doc/source/storage_format.rst
index 1cc9419..6c1668d 100644
--- a/doc/source/storage_format.rst
+++ b/doc/source/storage_format.rst
@@ -273,7 +273,15 @@ locations is written as the data object. The elements are all written to
 the Group path set by :py:attr:`Options.group_for_references` with a
 randomized name (this package keeps generating randomized names till an
 available one is found). It must be ``'/#refs#'`` for MATLAB (setting
-``matlab_compatible`` sets this automatically).
+``matlab_compatible`` sets this automatically). Those elements that
+can't be written (doing MATLAB compatibility and we are set to discard
+MATLAB incompatible types
+:py:attr:`Options.action_for_matlab_incompatible`) will instead end up
+being a reference to the canonical empty inside the group. The canonical
+empty has the same format as in MATLAB and is a Dataset named 'a' of
+``np.uint32/64([0, 0])`` with the Attribute 'MATLAB_class' set to
+'canonical empty' and the Attribute 'MATLAB_empty' set to
+``np.uint8(1)``.
 
 
 Optional Data Transformations

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