Refactor the API Ref #1639
Refactor the API Ref #1639
Conversation
There was a problem hiding this comment.
Thanks @nanjekyejoannah!
For the changes with autosummary I agree (it is exactly what I was thinking).
One thing I wonder is if we can simplify the name in the left table of contents (e.g. if I'm within geomstats.geometry.manifold.Manifold, it suffices to have the name manifold.Manifold - and later even Manifold will suffice).
For the changes in the docstrings, please take a look to linting errors (see link below). Additionally, check in the contributing guide how you can run flake8 locally, so you can immediately see what are the (linting) errors you may introduce.
geomstats/geometry/euclidean.py
Outdated
| """ | ||
| Class for Euclidean spaces. |
There was a problem hiding this comment.
Notice this is not allowed by linting (check e.g. here).
It is expected that the first line of the docstring contains a brief description of the class/function/method.
geomstats/geometry/hypersphere.py
Outdated
| @@ -828,7 +887,11 @@ def squared_dist(self, point_a, point_b, **kwargs): | |||
| def parallel_transport( | |||
| self, tangent_vec, base_point, direction=None, end_point=None | |||
| ): | |||
| r"""Compute the parallel transport of a tangent vector. | |||
There was a problem hiding this comment.
When escapes are used within the docstrings, e.g. within math expressions, we need to add "r" to allow proper rendering. Notice that linting also checks it.
|
I have the API ref PR updated, several things:
We can chat tomorrow and scope what we can reasonably address. |
|
I'll close this as we decide to move in smaller steps. #1663 addresses the same issues as here. |
@LPereira95 before I commit everything, can we go through this draft API ref for the geometry module and verify what we want before I modify the rest of the docs.