summaryrefslogtreecommitdiff
path: root/src/python/doc/bottleneck_distance_user.rst
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-06-05 20:16:38 +0200
committerMarc Glisse <marc.glisse@inria.fr>2020-06-05 20:16:38 +0200
commit82dc35dd749a1f388be268d7a7e3bd22f18afcf7 (patch)
treed057b579dd35c10c2b1dd6b86e24fe9e1d5002cc /src/python/doc/bottleneck_distance_user.rst
parentbea81f2d7bc53876a6f071c919663261314965ab (diff)
Doc changes after Vincent's review
Diffstat (limited to 'src/python/doc/bottleneck_distance_user.rst')
-rw-r--r--src/python/doc/bottleneck_distance_user.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/python/doc/bottleneck_distance_user.rst b/src/python/doc/bottleneck_distance_user.rst
index 49bd3706..6c6e08d9 100644
--- a/src/python/doc/bottleneck_distance_user.rst
+++ b/src/python/doc/bottleneck_distance_user.rst
@@ -10,7 +10,7 @@ Definition
.. include:: bottleneck_distance_sum.inc
This implementation by François Godi is based on ideas from "Geometry Helps in Bottleneck Matching and Related Problems"
-:cite:`DBLP:journals/algorithmica/EfratIK01` and requires `CGAL <installation.html#cgal>`_.
+:cite:`DBLP:journals/algorithmica/EfratIK01` and requires `CGAL <installation.html#cgal>`_ (`GPL v3 </licensing/>`_).
.. autofunction:: gudhi.bottleneck_distance
@@ -20,7 +20,8 @@ based on "Geometry Helps to Compare Persistence Diagrams"
:cite:`Kerber:2017:GHC:3047249.3064175` by Michael Kerber, Dmitriy
Morozov, and Arnur Nigmetov.
-Beware that its approximation allows for a multiplicative error, while the function above uses an additive error.
+.. warning::
+ Beware that its approximation allows for a multiplicative error, while the function above uses an additive error.
.. autofunction:: gudhi.hera.bottleneck_distance