Merge branch 'master' into kernels

1 files changed, 5 insertions, 2 deletions

diff --git a/src/Witness_complex/include/gudhi/Strong_witness_complex.h b/src/Witness_complex/include/gudhi/Strong_witness_complex.h
index fd6b3f38..03d6d2e7 100644
--- a/src/Witness_complex/include/gudhi/Strong_witness_complex.h
+++ b/src/Witness_complex/include/gudhi/Strong_witness_complex.h
@@ -40,10 +40,13 @@ namespace witness_complex {
  * \brief Constructs strong witness complex for a given table of nearest landmarks with respect to witnesses.
  * \ingroup witness_complex
  *
- * \tparam Nearest_landmark_table_ needs to be a range of a range of pairs of nearest landmarks and distances.
+ * \tparam Nearest_landmark_table_ needs to be a range (one entry per witness)
+ *         of sorted ranges of pairs of nearest landmarks and distances.
  *         The class Nearest_landmark_table_::value_type must be a copiable range.
  *         The range of pairs must admit a member type 'iterator'. The dereference type 
- *         of the pair range iterator needs to be 'std::pair<std::size_t, double>'.
+ *         of the pair range iterator needs to be 'std::pair<std::size_t, double>'
+ *         where the first element is the index of the landmark, and the second its
+ *         (squared) distance to the witness.
  */
 template< class Nearest_landmark_table_ >
 class Strong_witness_complex {