[python-hdf5storage] 118/152: Fixed missing information about exceptions in docstrings.

[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 9194e81eec4b7b6242a05fdbac1cb5c918eeada0
Author: Freja Nordsiek <fnordsie at gmail.com>
Date:   Thu Feb 13 21:54:44 2014 -0500

    Fixed missing information about exceptions in docstrings.
---
 hdf5storage/Marshallers.py | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/hdf5storage/Marshallers.py b/hdf5storage/Marshallers.py
index 1a52016..8bf442e 100644
--- a/hdf5storage/Marshallers.py
+++ b/hdf5storage/Marshallers.py
@@ -55,6 +55,19 @@ def write_object_array(f, data, options):
     options : hdf5storage.core.Options
         hdf5storage options object.
 
+    Returns
+    -------
+    numpy.ndarray of h5py.Reference
+        A reference array pointing to all the elements written to the
+        HDF5 file. For those that couldn't be written, the respective
+        element points to the canonical empty.
+
+    Raises
+    ------
+    TypeNotMatlabCompatibleError
+        If writing a type not compatible with MATLAB and
+        `options.action_for_matlab_incompatible` is set to ``'error'``.
+
     See Also
     --------
     hdf5storage.Options.group_for_references
@@ -273,6 +286,10 @@ class TypeMarshaller(object):
         ------
         NotImplementedError
             If writing 'data' to file is currently not supported.
+        TypeNotMatlabCompatibleError
+            If writing a type not compatible with MATLAB and
+            `options.action_for_matlab_incompatible` is set to
+            ``'error'``.
 
         Notes
         -----

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