python doc clarifications

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/misc-glisse@3001 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 9dc859e34125fc163c02a32353879b59fff610a7

1 files changed, 7 insertions, 4 deletions

diff --git a/src/cython/cython/simplex_tree.pyx b/src/cython/cython/simplex_tree.pyx
index 8a436619..0cb575d2 100644
--- a/src/cython/cython/simplex_tree.pyx
+++ b/src/cython/cython/simplex_tree.pyx
@@ -106,8 +106,8 @@ cdef class SimplexTree:
         return self.pcohptr != NULL
 
     def filtration(self, simplex):
-        """This function returns the simplicial complex filtration value for a
-        given N-simplex.
+        """This function returns the filtration value for a given N-simplex in
+        this simplicial complex, or +infinity if it is not in the complex.
 
         :param simplex: The N-simplex, represented by a list of vertex.
         :type simplex: list of int.
@@ -222,14 +222,17 @@ cdef class SimplexTree:
 
     def insert(self, simplex, filtration=0.0):
         """This function inserts the given N-simplex and its subfaces with the
-        given filtration value (default value is '0.0').
+        given filtration value (default value is '0.0'). If some of those
+        simplices are already present with a higher filtration value, their
+        filtration value is lowered.
 
         :param simplex: The N-simplex to insert, represented by a list of
             vertex.
         :type simplex: list of int.
         :param filtration: The filtration value of the simplex.
         :type filtration: float.
-        :returns:  true if the simplex was found, false otherwise.
+        :returns:  true if the simplex was not yet in the complex, false
+            otherwise (whatever its original filtration value).
         :rtype:  bool
         """
         cdef vector[int] csimplex