Fix documentation formatting (#68)

JeffLIrion · Nov 10, 2023 · 1ac4d6c · 1ac4d6c
1 parent 945a2e0
commit 1ac4d6c
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/graphslam/pose/base_pose.py b/graphslam/pose/base_pose.py
@@ -423,7 +423,7 @@ def jacobian_boxplus(self):
         raise NotImplementedError
 
     def jacobian_self_oplus_point_wrt_self(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where :math:`p_2` is a point.
 
         Let
 
@@ -451,7 +451,7 @@ def jacobian_self_oplus_point_wrt_self(self, point):
         raise NotImplementedError
 
     def jacobian_self_oplus_point_wrt_point(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where :math:`p_2` is a point.
 
         Let
 

diff --git a/graphslam/pose/r2.py b/graphslam/pose/r2.py
@@ -294,7 +294,7 @@ def jacobian_boxplus(self):
         return np.eye(2)
 
     def jacobian_self_oplus_point_wrt_self(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where :math:`p_2` is a point.
 
         Parameters
         ----------
@@ -310,7 +310,7 @@ def jacobian_self_oplus_point_wrt_self(self, point):
         return np.eye(2)
 
     def jacobian_self_oplus_point_wrt_point(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where :math:`p_2` is a point.
 
         Parameters
         ----------

diff --git a/graphslam/pose/r3.py b/graphslam/pose/r3.py
@@ -294,7 +294,7 @@ def jacobian_boxplus(self):
         return np.eye(3)
 
     def jacobian_self_oplus_point_wrt_self(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where :math:`p_2` is a point.
 
         Parameters
         ----------
@@ -310,7 +310,7 @@ def jacobian_self_oplus_point_wrt_self(self, point):
         return np.eye(3)
 
     def jacobian_self_oplus_point_wrt_point(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where :math:`p_2` is a point.
 
         Parameters
         ----------

diff --git a/graphslam/pose/se2.py b/graphslam/pose/se2.py
@@ -392,7 +392,7 @@ def jacobian_boxplus(self):
         # fmt: on
 
     def jacobian_self_oplus_point_wrt_self(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where :math:`p_2` is a point.
 
         Parameters
         ----------
@@ -411,7 +411,7 @@ def jacobian_self_oplus_point_wrt_self(self, point):
         # fmt: on
 
     def jacobian_self_oplus_point_wrt_point(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where :math:`p_2` is a point.
 
         Parameters
         ----------

diff --git a/graphslam/pose/se3.py b/graphslam/pose/se3.py
@@ -451,7 +451,7 @@ def jacobian_boxplus(self):
         # fmt: on
 
     def jacobian_self_oplus_point_wrt_self(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_1`, where :math:`p_2` is a point.
 
         Parameters
         ----------
@@ -472,7 +472,7 @@ def jacobian_self_oplus_point_wrt_self(self, point):
         # fmt: on
 
     def jacobian_self_oplus_point_wrt_point(self, point):
-        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where `:math:p_2` is a point.
+        r"""Compute the Jacobian of :math:`p_1 \oplus p_2` w.r.t. :math:`p_2`, where :math:`p_2` is a point.
 
         Parameters
         ----------