From 82dc35dd749a1f388be268d7a7e3bd22f18afcf7 Mon Sep 17 00:00:00 2001
From: Marc Glisse <marc.glisse@inria.fr>
Date: Fri, 5 Jun 2020 20:16:38 +0200
Subject: Doc changes after Vincent's review

---
 src/python/gudhi/bottleneck.cc | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'src/python/gudhi/bottleneck.cc')

diff --git a/src/python/gudhi/bottleneck.cc b/src/python/gudhi/bottleneck.cc
index 732cb9a8..59be6088 100644
--- a/src/python/gudhi/bottleneck.cc
+++ b/src/python/gudhi/bottleneck.cc
@@ -29,7 +29,8 @@ PYBIND11_MODULE(bottleneck, m) {
           py::arg("diagram_1"), py::arg("diagram_2"),
           py::arg("e") = (std::numeric_limits<double>::min)(),
           R"pbdoc(
-    This function returns the point corresponding to a given vertex.
+    Compute the Bottleneck distance between two diagrams.
+    Points at infinity and on the diagonal are supported.
 
     :param diagram_1: The first diagram.
     :type diagram_1: numpy array of shape (m,2)
-- 
cgit v1.2.3