From 36046b2051493a0d06b26106b22a544bddc936c2 Mon Sep 17 00:00:00 2001
From: Brent Yi <yibrenth@gmail.com>
Date: Sun, 5 May 2024 22:41:15 -0700
Subject: [PATCH] More comments

---
 README.md      | 2 +-
 jaxlie/_se2.py | 3 ++-
 jaxlie/_se3.py | 3 ++-
 jaxlie/_so2.py | 3 ++-
 jaxlie/_so3.py | 3 ++-
 5 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 0cf7c5e..5b45fe3 100644
--- a/README.md
+++ b/README.md
@@ -59,7 +59,7 @@ Where each group supports:
   <code>jaxlie.<strong>manifold.\*</strong></code>).
 - Compatibility with standard JAX function transformations. (see
   [./examples/vmap_example.py](./examples/vmap_example.py))
-- Broadcasting.
+- Broadcasting for leading axes.
 - (Un)flattening as pytree nodes.
 - Serialization using [flax](https://github.com/google/flax).
 
diff --git a/jaxlie/_se2.py b/jaxlie/_se2.py
index 0b18456..929a58f 100644
--- a/jaxlie/_se2.py
+++ b/jaxlie/_se2.py
@@ -18,7 +18,8 @@
 )
 @jdc.pytree_dataclass
 class SE2(_base.SEBase[SO2]):
-    """Special Euclidean group for proper rigid transforms in 2D.
+    """Special Euclidean group for proper rigid transforms in 2D. Broadcasting
+    rules are the same as for numpy.
 
     Internal parameterization is `(cos, sin, x, y)`. Tangent parameterization is `(vx,
     vy, omega)`.
diff --git a/jaxlie/_se3.py b/jaxlie/_se3.py
index 3bd4e6d..3c1d8e6 100644
--- a/jaxlie/_se3.py
+++ b/jaxlie/_se3.py
@@ -31,7 +31,8 @@ def _skew(omega: hints.Array) -> jax.Array:
 )
 @jdc.pytree_dataclass
 class SE3(_base.SEBase[SO3]):
-    """Special Euclidean group for proper rigid transforms in 3D.
+    """Special Euclidean group for proper rigid transforms in 3D. Broadcasting
+    rules are the same as for numpy.
 
     Internal parameterization is `(qw, qx, qy, qz, x, y, z)`. Tangent parameterization
     is `(vx, vy, vz, omega_x, omega_y, omega_z)`.
diff --git a/jaxlie/_so2.py b/jaxlie/_so2.py
index 82b9e26..22fde85 100644
--- a/jaxlie/_so2.py
+++ b/jaxlie/_so2.py
@@ -19,7 +19,8 @@
 )
 @jdc.pytree_dataclass
 class SO2(_base.SOBase):
-    """Special orthogonal group for 2D rotations.
+    """Special orthogonal group for 2D rotations. Broadcasting rules are the
+    same as for `numpy`.
 
     Internal parameterization is `(cos, sin)`. Tangent parameterization is `(omega,)`.
     """
diff --git a/jaxlie/_so3.py b/jaxlie/_so3.py
index e25dc88..68a1559 100644
--- a/jaxlie/_so3.py
+++ b/jaxlie/_so3.py
@@ -19,7 +19,8 @@
 )
 @jdc.pytree_dataclass
 class SO3(_base.SOBase):
-    """Special orthogonal group for 3D rotations.
+    """Special orthogonal group for 3D rotations. Broadcasting rules are the same as
+    for numpy.
 
     Internal parameterization is `(qw, qx, qy, qz)`. Tangent parameterization is
     `(omega_x, omega_y, omega_z)`.