summaryrefslogtreecommitdiff
path: root/src/python/doc/persistence_graphical_tools_sum.inc
diff options
context:
space:
mode:
authortlacombe <lacombe1993@gmail.com>2020-02-25 18:20:30 +0100
committertlacombe <lacombe1993@gmail.com>2020-02-25 18:20:30 +0100
commit3ecf0caf4efbea0fabf4af0df490900374abda8b (patch)
tree7caf32e22e3ba14aa507861000c313cf3007d8a0 /src/python/doc/persistence_graphical_tools_sum.inc
parentcdcd2904a1c682625670a62608fd781bfd571516 (diff)
say in doc that functions return ax
Diffstat (limited to 'src/python/doc/persistence_graphical_tools_sum.inc')
-rw-r--r--src/python/doc/persistence_graphical_tools_sum.inc6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/python/doc/persistence_graphical_tools_sum.inc b/src/python/doc/persistence_graphical_tools_sum.inc
index 0cdf8072..2ddaccfc 100644
--- a/src/python/doc/persistence_graphical_tools_sum.inc
+++ b/src/python/doc/persistence_graphical_tools_sum.inc
@@ -3,10 +3,10 @@
+-----------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+
| .. figure:: | These graphical tools comes on top of persistence results and allows | :Author: Vincent Rouvreau |
- | img/graphical_tools_representation.png | the user to build easily persistence barcode, diagram or density. | |
+ | img/graphical_tools_representation.png | the user to display easily persistence barcode, diagram or density. | |
| | | :Introduced in: GUDHI 2.0.0 |
- | | | |
- | | | :Copyright: MIT |
+ | | Note that these functions return the matplotlib axis, allowing | |
+ | | for further modifications (title, aspect, etc.) | :Copyright: MIT |
| | | |
| | | :Requires: matplotlib, numpy and scipy |
+-----------------------------------------------------------------+-----------------------------------------------------------------------+-----------------------------------------------+