Skip to content

Commit bc3db1a

Browse files
committed
use r""" to escape sphinx markup with backslashes
1 parent dd8b46a commit bc3db1a

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

spatialmath/base/graphics.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ def plot_point(pos, marker="bs", text=None, ax=None, textargs=None, **kwargs):
196196

197197

198198
def plot_homline(lines, *args, ax=None, xlim=None, ylim=None, **kwargs):
199-
"""
199+
r"""
200200
Plot a homogeneous line using matplotlib
201201
202202
:param lines: homgeneous lines
@@ -539,7 +539,7 @@ def plot_circle(
539539

540540

541541
def ellipse(E, centre=(0, 0), scale=1, confidence=None, resolution=40, inverted=False):
542-
"""
542+
r"""
543543
Points on ellipse
544544
545545
:param E: ellipse
@@ -604,7 +604,7 @@ def plot_ellipse(
604604
filled=False,
605605
**kwargs
606606
):
607-
"""
607+
r"""
608608
Plot an ellipse using matplotlib
609609
610610
:param E: matrix describing ellipse
@@ -735,8 +735,8 @@ def plot_sphere(radius, centre=(0, 0, 0), pose=None, resolution=50, ax=None, **k
735735
def ellipsoid(
736736
E, centre=(0, 0, 0), scale=1, confidence=None, resolution=40, inverted=False
737737
):
738-
"""
739-
Points on an ellipsoid
738+
r"""
739+
rPoints on an ellipsoid
740740
741741
:param centre: centre of ellipsoid, defaults to (0, 0, 0)
742742
:type centre: array_like(3), optional
@@ -796,7 +796,7 @@ def plot_ellipsoid(
796796
ax=None,
797797
**kwargs
798798
):
799-
"""
799+
r"""
800800
Draw an ellipsoid using matplotlib
801801
802802
:param E: ellipsoid

spatialmath/base/transforms3d.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -688,7 +688,7 @@ def angvec2tr(theta, v, unit="rad"):
688688

689689

690690
def exp2r(w):
691-
"""
691+
r"""
692692
Create an SO(3) rotation matrix from exponential coordinates
693693
694694
:param w: exponential coordinate vector
@@ -730,7 +730,7 @@ def exp2r(w):
730730

731731

732732
def exp2tr(w):
733-
"""
733+
r"""
734734
Create an SE(3) pure rotation matrix from exponential coordinates
735735
736736
:param w: exponential coordinate vector
@@ -1891,7 +1891,7 @@ def x2tr(x, representation="rpy/xyz"):
18911891

18921892

18931893
def rot2jac(R, representation="rpy/xyz"):
1894-
"""
1894+
r"""
18951895
Velocity transform for analytical Jacobian
18961896
18971897
:param R: SO(3) rotation matrix
@@ -1951,7 +1951,7 @@ def rot2jac(R, representation="rpy/xyz"):
19511951

19521952

19531953
def angvelxform(𝚪, inverse=False, full=True, representation="rpy/xyz"):
1954-
"""
1954+
r"""
19551955
Angular velocity transformation
19561956
19571957
:param 𝚪: angular representation
@@ -2101,7 +2101,7 @@ def angvelxform(𝚪, inverse=False, full=True, representation="rpy/xyz"):
21012101

21022102

21032103
def angvelxform_dot(𝚪, 𝚪d, full=True, representation="rpy/xyz"):
2104-
"""
2104+
r"""
21052105
Angular acceleration transformation
21062106
21072107
:param 𝚪: angular representation

0 commit comments

Comments
 (0)