doc

e3nn_jax/_src/s2grid.py

@@ -396,7 +396,23 @@ def s2_sum_of_diracs(positions: jnp.ndarray, weights: jnp.ndarray, lmax: int, *,
 
 
 def s2_irreps(lmax: int, p_val: int = 1, p_arg: int = -1) -> e3nn.Irreps:
-    """Returns all Irreps upto l = lmax and of the required parity."""
+    r"""The Irreps of coefficients of a spherical harmonics expansion.
+
+    .. math::
+
+        f(\vec x) = \sum_{l=0}^{L} \sum_{m=-l}^{l} c_l^m Y_{l,m}(\vec x)
+
+    When the inversion operator is applied to the signal, the new function :math:`I f` is given by
+
+    .. math::
+
+        [I f](\vec x) = p_{\text{val}} f(p_{\text{arg}} \vec x)
+
+    Args:
+        lmax (int): maximum degree of the expansion
+        p_val (int): parity of the value of the signal on the sphere (1 or -1)
+        p_arg (int): parity of the argument of the signal on the sphere (1 or -1)
+    """
     return e3nn.Irreps([(1, (l, p_val * p_arg**l)) for l in range(lmax + 1)])