summaryrefslogtreecommitdiff
path: root/src/python/gudhi/bottleneck.cc
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-06-05 19:33:53 +0200
committerMarc Glisse <marc.glisse@inria.fr>2020-06-05 19:33:53 +0200
commit4a437177cb2b10b6462380c39739a923c08dc121 (patch)
tree938e6fdb33c0f1973b886e99d40662df2830207f /src/python/gudhi/bottleneck.cc
parent25176e3ba75005f36cfe3ebc15e1fcba8cd3227b (diff)
Doc tweak by Vincent
Diffstat (limited to 'src/python/gudhi/bottleneck.cc')
-rw-r--r--src/python/gudhi/bottleneck.cc2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/python/gudhi/bottleneck.cc b/src/python/gudhi/bottleneck.cc
index 9337ce59..838bf9eb 100644
--- a/src/python/gudhi/bottleneck.cc
+++ b/src/python/gudhi/bottleneck.cc
@@ -46,7 +46,7 @@ PYBIND11_MODULE(bottleneck, m) {
bits of the mantissa may be wrong). This version of the algorithm takes
advantage of the limited precision of `double` and is usually a lot
faster to compute, whatever the value of `e`.
- Thus, by default, `e` is the smallest positive double.
+ Thus, by default (`e=None`), `e` is the smallest positive double.
:type e: float
:rtype: float
:returns: the bottleneck distance.