Doc review : prune_above_filtration about automatic_dimension_set mechanism was too strict.

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

Former-commit-id: bccef80ba3f70f87dff28cfa3a85c50f072f695e

1 files changed, 3 insertions, 2 deletions

diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h
index fd6cd72a..6494aa5d 100644
--- a/src/Simplex_tree/include/gudhi/Simplex_tree.h
+++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h
@@ -1161,8 +1161,9 @@ class Simplex_tree {
    * \post Some simplex tree functions require the filtration to be valid. `prune_above_filtration()`
    * function is not launching `initialize_filtration()` but returns the filtration modification information. If the
    * complex has changed , please call `initialize_filtration()` to recompute it.
-   * \post Be aware that `prune_above_filtration()` may change the simplex tree dimension (`automatic_dimension_set()`
-   * to be done).
+   * \post Note that the dimension of the simplicial complex may be lower after calling `prune_above_filtration()`
+   * than it was before. However, `Simplex_tree::dimension()` will return the old value, which remains a valid upper
+   * bound. If you care, you can call `automatic_dimension_set()` to recompute the exact dimension.
    */
   bool prune_above_filtration(Filtration_value filtration) {
     return rec_prune_above_filtration(root(), filtration);