summaryrefslogtreecommitdiff
path: root/src/python/doc/tangential_complex_user.rst
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2019-11-26 23:08:53 +0100
committerMarc Glisse <marc.glisse@inria.fr>2019-11-29 10:52:10 +0100
commitfe3bbb9b3de5001ba943d3be7109712847ec44ef (patch)
tree342d67fdc5a661d2238e2444f1dd778647c5c0b1 /src/python/doc/tangential_complex_user.rst
parent8ebfb8c5de9c55a20e3dafebc8f506ccb698bb68 (diff)
Fix various links for sphinx
and some minor doc changes along the way. (why were we documenting a hasse diagram that doesn't exist?)
Diffstat (limited to 'src/python/doc/tangential_complex_user.rst')
-rw-r--r--src/python/doc/tangential_complex_user.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/python/doc/tangential_complex_user.rst b/src/python/doc/tangential_complex_user.rst
index ebfe1e29..852cf5b6 100644
--- a/src/python/doc/tangential_complex_user.rst
+++ b/src/python/doc/tangential_complex_user.rst
@@ -107,12 +107,12 @@ inconsistencies, but is not guaranteed to succeed.
Output
^^^^^^
-The result of the computation is exported as a Simplex_tree. It is the union of
+The result of the computation is exported as a :class:`~gudhi.SimplexTree`. It is the union of
the stars of all the input points. A vertex in the Simplex Tree is the index of
the point in the range provided by the user. The point corresponding to a
-vertex can also be obtained through the Tangential_complex::get_point function.
+vertex can also be obtained through the :func:`gudhi.TangentialComplex.get_point` function.
Note that even if the positions of the points are perturbed, their original
-positions are kept (e.g. Tangential_complex::get_point returns the original
+positions are kept (e.g. :func:`~gudhi.TangentialComplex.get_point` returns the original
position of the point).
The result can be obtained after the computation of the Tangential complex