[python-hdf5storage] 37/152: Added what Python types are converted to in numpy in README.rst

[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 e3e288948048256d6253219bb8093430b4458e75
Author: Freja Nordsiek <fnordsie at gmail.com>
Date:   Sun Jan 26 20:25:52 2014 -0500

    Added what Python types are converted to in numpy in README.rst
---
 README.rst | 73 ++++++++++++++++++++++++++++++++------------------------------
 1 file changed, 38 insertions(+), 35 deletions(-)

diff --git a/README.rst b/README.rst
index d6f488c..13059cc 100644
--- a/README.rst
+++ b/README.rst
@@ -49,43 +49,50 @@ read and write support for a limited set of Python and MATLAB types.
 Supported Types
 ===============
 
-The supported Python and MATLAB types are given in the tables below. The
-first table gives which Python types can be read and written, the
-first version of this package to support it, the MATLAB class it
-becomes if targetting a MAT file, and the first version of this
-package to support writing it so MATlAB can read it. The second table
-gives the MATLAB classes that can be read from a MAT file, the first
-version of this package that can read them, and the Python type they
-are read as. The tables assume that one has imported numpy as::
+The supported Python and MATLAB types are given in the tables below.  The tables assume that one has imported numpy as::
 
     import numpy as np
 
-=============  =======  =======  ========
-Python                  MATLAB
-----------------------  -----------------
-Type           Version  Class    Version
-=============  =======  =======  ========
-bool           0.1      logical  0.1
-None           0.1      ``[]``   0.1
-int            0.1      int64    0.1
-float          0.1      double   0.1
-complex        0.1      double   0.1
-str            0.1      char     0.1 [1]_
-bytes          0.1      char     0.1
-bytearray      0.1      char     0.1
-np.bool\_      0.1      logical  0.1
-np.uint8       0.1      uint8    0.1
+The table gives which Python types can be read and written, the first
+version of this package to support it, the numpy type it gets
+converted to for storage (if type information is not written, that
+will be what it is read back as) the MATLAB class it becomes if
+targetting a MAT file, and the first version of this package to
+support writing it so MATlAB can read it.
+
+=============  =======  ================  =======  ========
+Python                                    MATLAB
+----------------------------------------  -----------------
+Type           Version  Converted to      Class    Version
+=============  =======  ================  =======  ========
+bool           0.1      np.bool\_          logical  0.1
+None           0.1      ``np.array([])``  ``[]``   0.1
+int            0.1      np.int64          int64    0.1
+float          0.1      np.float64        double   0.1
+complex        0.1      np.complex128     double   0.1
+str            0.1      np.bytes\_        char     0.1 [1]_
+bytes          0.1      np.bytes\_        char     0.1
+bytearray      0.1      np.bytes\_        char     0.1
+np.bool\_      0.1                        logical  0.1
+np.uint8       0.1                        uint8    0.1
 np.float16     0.1
-np.float32     0.1      single   0.1
-np.float64     0.1      double   0.1
+np.float32     0.1                        single   0.1
+np.float64     0.1                        double   0.1
 np.complex32   0.1
-np.complex64   0.1      single   0.1
-np.complex128  0.1      double   0.1
-np.str\_       0.1      uint32   0.1 [2]_
-np.bytes\_     0.1      char     0.1
-dict           0.1      struct   0.1 [3]_
-=============  =======  =======  ========
+np.complex64   0.1                        single   0.1
+np.complex128  0.1                        double   0.1
+np.str\_       0.1      np.uint32         uint32   0.1 [2]_
+np.bytes\_     0.1                        char     0.1
+dict           0.1                        struct   0.1 [3]_
+=============  =======  ================  =======  ========
 
+.. [1] Converted to ASCII, so characters outside of that set are lost.
+.. [2] Simply copied over as the uint32 versions of each UTF-32 character.
+.. [3] All keys must be ``str``.
+
+This table gives the MATLAB classes that can be read from a MAT file,
+the first version of this package that can read them, and the Python
+type they are read as.
 
 ============  =======  ================================
 MATLAB Class  Version  Python Type
@@ -104,9 +111,5 @@ int64         0.1      np.int64
 struct        0.1      dict [5]_
 ============  =======  ================================
 
-
-.. [1] Converted to ASCII, so characters outside of that set are lost.
-.. [2] Simply copied over as the uint32 versions of each UTF-32 character.
-.. [3] All keys must be ``str``.
 .. [4] Depends on whether there is a complex part or not.
 .. [5] Structure arrays are not supported.

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