code review: proposal from Hannah

GUDHI · Feb 17, 2025 · bc7fbb6 · bc7fbb6
1 parent 4ee4878
commit bc7fbb6
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex.h b/src/Alpha_complex/include/gudhi/Alpha_complex.h
@@ -377,7 +377,8 @@ class Alpha_complex {
    * Initialization can be launched once.
    *
    * \exception std::invalid_argument In case of a Weighted Alpha complex with `Output_squared_values` set to `false`,
-   * as Weighted Alpha complex can have negative filtration values.
+   * as the filtration values of a Weighted Alpha complex results from a power product and not from an euclidean
+   * distance. Therefore this template argument should be kept to the default value.
    */
   template <bool Output_squared_values = true,
             typename SimplicialComplexForAlpha,