[python-hdf5storage] 73/84: Added compression information to the introduction in the documentation. (cherry picked from commit 95bcf291dbd280c03e3693d0ff2a488e792db7e7)

[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 0395073e3d85b9742cf938656b099eb5f89e0df7
Author: Freja Nordsiek <fnordsie at gmail.com>
Date:   Tue Sep 1 01:52:59 2015 -0400

    Added compression information to the introduction in the documentation.
    (cherry picked from commit 95bcf291dbd280c03e3693d0ff2a488e792db7e7)
---
 doc/source/compression.rst  |  2 ++
 doc/source/introduction.rst | 17 +++++++++++++++++
 2 files changed, 19 insertions(+)

diff --git a/doc/source/compression.rst b/doc/source/compression.rst
index 13b9c04..cedd5e8 100644
--- a/doc/source/compression.rst
+++ b/doc/source/compression.rst
@@ -1,5 +1,7 @@
 .. currentmodule:: hdf5storage
 
+.. _Compression:
+
 ===========
 Compression
 ===========
diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst
index 1b6c4c9..718b812 100644
--- a/doc/source/introduction.rst
+++ b/doc/source/introduction.rst
@@ -67,6 +67,13 @@ The two main options are :py:attr:`Options.store_python_metadata` and
 :py:attr:`Options.oned_as`.
 
 
+.. versionadded:: 0.2
+
+   Support for the transparent compression of data has been added. It
+   is enabled by default, compressing all python objects resulting in
+   HDF5 Datasets larger than 16 KB with the GZIP/Deflate algorithm.
+
+
 store_python_metadata
 ---------------------
 
@@ -133,6 +140,16 @@ to be made 2 dimensional making them either into row vectors or column
 vectors. This option sets which they become when imported into MATLAB.
 
 
+compress
+--------
+
+.. versionadded:: 0.2
+
+``bool``
+
+Whether to use compression when writing data. Enabled (``True``) by default. See :ref:`Compression` for more information.
+
+
 Convenience Functions for MATLAB MAT Files
 ==========================================
 

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