summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorVincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com>2020-06-30 23:10:29 -0700
committerGitHub <noreply@github.com>2020-06-30 23:10:29 -0700
commit3bce2a71ab4a0fabb96fce56f32b605def0897a6 (patch)
tree10b3e7374afc75a66b455dd53f9e8572d0b92d9c /src
parent589a086317070c8a873051a5ca45cc56815ff53e (diff)
Doc review: commit suggestion
Co-authored-by: Marc Glisse <marc.glisse@inria.fr>
Diffstat (limited to 'src')
-rw-r--r--src/Collapse/include/gudhi/Flag_complex_edge_collapser.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h b/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h
index e26f32f7..60d75211 100644
--- a/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h
+++ b/src/Collapse/include/gudhi/Flag_complex_edge_collapser.h
@@ -345,7 +345,7 @@ class Flag_complex_edge_collapser {
* \fn auto Gudhi::collapse::flag_complex_collapse_edges(FilteredEdgeRange const& edges)
*
* \tparam FilteredEdgeRange furnishes `std::begin` and `std::end` methods and returns an iterator on a
- * FilteredEdge of type `std::tuple<Vertex_handle, Vertex_handle, Filtration_value>`
+ * FilteredEdge of type `std::tuple<Vertex_handle, Vertex_handle, Filtration_value>` where Vertex_handle is the index of a vertex.
*
* \ingroup edge_collapse
*