[python-hdf5storage] 114/152: Documentation and docstring updates and fixes.
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Mon Feb 29 08:24:40 UTC 2016
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 760d2e79a8ce02a6605d47a08fb3e3a9a5da10a5
Author: Freja Nordsiek <fnordsie at gmail.com>
Date: Thu Feb 13 18:31:31 2014 -0500
Documentation and docstring updates and fixes.
---
doc/source/hdf5storage.Marshallers.rst | 11 +++++++++++
doc/source/hdf5storage.lowlevel.rst | 29 +++++++++++++++++++++++++++++
doc/source/hdf5storage.rst | 9 +++++++++
doc/source/hdf5storage.utilities.rst | 17 +++++++++++++++++
doc/source/introduction.rst | 12 ++++++++++++
hdf5storage/__init__.py | 8 ++++----
6 files changed, 82 insertions(+), 4 deletions(-)
diff --git a/doc/source/hdf5storage.Marshallers.rst b/doc/source/hdf5storage.Marshallers.rst
index 7182b22..9ec2197 100644
--- a/doc/source/hdf5storage.Marshallers.rst
+++ b/doc/source/hdf5storage.Marshallers.rst
@@ -5,6 +5,17 @@ hdf5storage.Marshallers
.. automodule:: hdf5storage.Marshallers
+.. autosummary::
+
+ TypeMarshaller
+ NumpyScalarArrayMarshaller
+ PythonScalarMarshaller
+ PythonStringMarshaller
+ PythonNoneMarshaller
+ PythonDictMarshaller
+ PythonListMarshaller
+ PythonTupleSetDequeMarshaller
+
TypeMarshaller
--------------
diff --git a/doc/source/hdf5storage.lowlevel.rst b/doc/source/hdf5storage.lowlevel.rst
index 0c9abd1..5848c7a 100644
--- a/doc/source/hdf5storage.lowlevel.rst
+++ b/doc/source/hdf5storage.lowlevel.rst
@@ -5,6 +5,35 @@ hdf5storage.lowlevel
.. automodule:: hdf5storage.lowlevel
+.. autosummary::
+
+ Hdf5storageError
+ CantReadError
+ TypeNotMatlabCompatibleError
+ write_data
+ read_data
+
+
+Hdf5storageError
+----------------
+
+.. autoexception:: Hdf5storageError
+ :show-inheritance:
+
+
+CantReadError
+-------------
+
+.. autoexception:: CantReadError
+ :show-inheritance:
+
+
+TypeNotMatlabCompatibleError
+----------------------------
+
+.. autoexception:: TypeNotMatlabCompatibleError
+ :show-inheritance:
+
write_data
----------
diff --git a/doc/source/hdf5storage.rst b/doc/source/hdf5storage.rst
index 3c42bbc..b0ddff1 100644
--- a/doc/source/hdf5storage.rst
+++ b/doc/source/hdf5storage.rst
@@ -5,6 +5,15 @@ hdf5storage
.. automodule:: hdf5storage
+.. autosummary::
+
+ write
+ read
+ savemat
+ loadmat
+ Options
+ MarshallerCollection
+
write
-----
diff --git a/doc/source/hdf5storage.utilities.rst b/doc/source/hdf5storage.utilities.rst
index 6da1e13..9a4ce55 100644
--- a/doc/source/hdf5storage.utilities.rst
+++ b/doc/source/hdf5storage.utilities.rst
@@ -5,6 +5,23 @@ hdf5storage.utilities
.. automodule:: hdf5storage.utilities
+.. autosummary::
+
+ next_unused_name_in_group
+ convert_numpy_str_to_uint16
+ convert_numpy_str_to_uint32
+ decode_to_str
+ decode_to_numpy_str
+ decode_to_numpy_bytes
+ decode_complex
+ encode_complex
+ get_attribute
+ get_attribute_string
+ set_attribute
+ set_attribute_string
+ set_attribute_string_array
+ del_attribute
+
next_unused_name_in_group
-------------------------
diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst
index 96a31c2..4876945 100644
--- a/doc/source/introduction.rst
+++ b/doc/source/introduction.rst
@@ -109,6 +109,18 @@ and strings to be stored in UTF-16 but with no doublets).
values to something else automatically turns ``matlab_compatible``
off.
+action_for_matlab_incompatible
+------------------------------
+
+{``'ignore'``, ``'discard'``, ``'error'``}
+
+The action to perform when doing MATLAB compatibility
+(``matlab_compatible == True``) but a type
+being written is not MATLAB compatible. The actions are to write the
+data anyways ('ignore'), don't write the incompatible data ('discard'),
+or throw a :py:exc:`lowlevel.TypeNotMatlabCompatibleError`
+exception. The default is 'error'.
+
oned_as
-------
diff --git a/hdf5storage/__init__.py b/hdf5storage/__init__.py
index a02d535..f73ff53 100644
--- a/hdf5storage/__init__.py
+++ b/hdf5storage/__init__.py
@@ -83,10 +83,10 @@ class Options(object):
See Attributes.
matlab_compatible : bool, optional
See Attributes.
- action_for_matlab_incompatible: str, optional
+ action_for_matlab_incompatible : str, optional
See Attributes. Only valid values are 'ignore', 'discard', and
'error'.
- delete_unused_variables: : bool, optional
+ delete_unused_variables : bool, optional
See Attributes.
make_atleast_2d : bool, optional
See Attributes.
@@ -113,7 +113,7 @@ class Options(object):
----------
store_python_metadata : bool
matlab_compatible : bool
- action_for_matlab_incompatible: {'ignore', 'discard', 'error'}
+ action_for_matlab_incompatible : str
delete_unused_variables : bool
make_atleast_2d : bool
convert_numpy_bytes_to_utf16 : bool
@@ -130,7 +130,7 @@ class Options(object):
``h5py.Group.create_dataset`` options for writing scalars.
marshaller_collection : MarshallerCollection
Collection of marshallers to disk.
-
+
"""
def __init__(self, store_python_metadata=True,
matlab_compatible=True,
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-hdf5storage.git
More information about the debian-science-commits
mailing list