[h5py] 288/455: More docs updates

[Ghislain Vaillant]

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

ghisvail-guest pushed a commit to annotated tag 1.3.0
in repository h5py.

commit 50caba5d445cf9eaaf4714f48f3788c008208122
Author: andrewcollette <andrew.collette at gmail.com>
Date:   Fri Jun 19 05:36:30 2009 +0000

    More docs updates
---
 docs/source/guide/hl.rst    |  1 +
 docs/source/guide/other.rst | 31 +++++++++++++++++++++++++++++++
 docs/source/guide/quick.rst |  2 +-
 3 files changed, 33 insertions(+), 1 deletion(-)

diff --git a/docs/source/guide/hl.rst b/docs/source/guide/hl.rst
index 2bcbe7e..b4ce4dd 100644
--- a/docs/source/guide/hl.rst
+++ b/docs/source/guide/hl.rst
@@ -19,6 +19,7 @@ separately below.
     dataset
     attr
     vl
+    other
 
 General information about h5py and HDF5
 =======================================
diff --git a/docs/source/guide/other.rst b/docs/source/guide/other.rst
new file mode 100644
index 0000000..974c2ec
--- /dev/null
+++ b/docs/source/guide/other.rst
@@ -0,0 +1,31 @@
+====================
+Supplemental modules
+====================
+
+Filters module
+--------------
+
+This module has only two public attributes, and allows you to check which
+filters are currently available for compression.  It is available at
+``h5py.filters``.
+
+.. attribute:: encode
+
+    Tuple of filters currently available for encoding.  Possible element
+    values are "gzip", "szip" and "lzf"
+
+.. attribute:: decode
+
+    Tuple of filters currently available for decoding.  Possible element
+    values are "gzip", "szip" and "lzf".  Note that for some HDF5
+    distributions, an SZIP decoder may be present, but not the encoder.
+
+All other functions in this module are internal and subject to change without
+warning.
+
+Selections module
+-----------------
+
+This module implements the details of mapping Python-style selection arguments
+to HDF5 hyperslab and point selections.  Selections are represented by
+instances of ``h5py.selections.Selection`` subclasses.
diff --git a/docs/source/guide/quick.rst b/docs/source/guide/quick.rst
index 70d4236..e7df947 100644
--- a/docs/source/guide/quick.rst
+++ b/docs/source/guide/quick.rst
@@ -11,7 +11,7 @@ comprehensive documentation is available at:
 
 The `HDF Group <http://www.hdfgroup.org>`_ is the final authority on HDF5.
 They also have an `introductory tutorial <http://www.hdfgroup.org/HDF5/Tutor/>`_
-which provides a good introduction.
+which provides a good overview.
 
 What is HDF5?
 =============

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