summaryrefslogtreecommitdiff
path: root/src/python/gudhi/datasets/generators/_points.cc
diff options
context:
space:
mode:
authorHind-M <hind.montassif@gmail.com>2021-05-27 09:56:02 +0200
committerHind-M <hind.montassif@gmail.com>2021-05-27 09:56:02 +0200
commit0b238a336f15128d777252cd084ee996491e6882 (patch)
tree63192446103752d52665ca72c7609b49b5bc192f /src/python/gudhi/datasets/generators/_points.cc
parent303b014508f849d8cb8a4369430068f54fa74c46 (diff)
Add documentation to python torus fonction and apply some modifications according to PR comments
Diffstat (limited to 'src/python/gudhi/datasets/generators/_points.cc')
-rw-r--r--src/python/gudhi/datasets/generators/_points.cc2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/python/gudhi/datasets/generators/_points.cc b/src/python/gudhi/datasets/generators/_points.cc
index 561fd6d8..003b65a3 100644
--- a/src/python/gudhi/datasets/generators/_points.cc
+++ b/src/python/gudhi/datasets/generators/_points.cc
@@ -56,7 +56,7 @@ PYBIND11_MODULE(_points, m) {
:param n_samples: The number of points to be generated.
:type n_samples: integer
- :param dim: The dimension.
+ :param dim: The dimension of the torus on which points would be generated in R^2*dim.
:type dim: integer
:param uniform: A flag to define if the points generation is uniform (i.e generated as a grid).
:type uniform: bool