Add comments to parts suggested by coderabbit

Author: markriegler

splinepy/helpme/integrate.py

@@ -20,7 +20,7 @@ def _get_integral_measure(spline):
     .. math::
         \\mathcal{J}_S = det(\\mathbf(J))
 
-    If the physical dimension is bigger then the parametric dimension it will
+    If the physical dimension is bigger than the parametric dimension it will
     return
 
     .. math::
@@ -59,6 +59,7 @@ def measure(spline_patch, positions):
 
 
 def _default_quadrature_orders(spline):
+    # Expected degree for quadrature based on spline's degrees and parametric dimension
     expected_degree = spline.degrees * spline.para_dim + 1
     if spline.is_rational:
         expected_degree += 2
@@ -132,6 +133,8 @@ def _get_quadrature_information(spline, orders=None):
 def volume(spline, orders=None):
     r"""Compute volume of a given spline
 
+    Uses quadrature to compute volume. Can handle patches with multiple elements.
+
     Parameters
     ----------
     spline : Spline
@@ -178,9 +181,11 @@ def parametric_function(
     Parameters
     ----------
     spline : Spline
-        (self if called via integrator)
+        The geometry over which the function is integrated
     function : Callable
+        The function to integrate
     orders : optional
+        Quadrature orders for numerical integration
 
     Returns
     -------
@@ -762,7 +767,14 @@ def precompute_transformation(self):
 
     @property
     def supports(self):
-        """ """
+        """
+        Get the quadrature points' supports.
+
+        Returns
+        -------
+        supports: np.ndarray
+            The supports
+        """
         if self._supports is None:
             self._supports = self._helpee.supports(self._trafo.all_quad_points)
 

tests/helpme/test_integrate.py

@@ -34,20 +34,20 @@ def test_volume_integration_embedded(np_rng):
     Test volume integration for splines using numerical integration of the
     Jacobi-Determinant
     """
-    # Test 1D -> 2D
+    # Test 1D -> 2D volume integration for Bezier
     expected_result = 2.0**1.5
     bezier = splinepy.Bezier(degrees=[1], control_points=[[0, 0], [2, 2]])
 
     assert np.allclose(bezier.integrate.volume(), expected_result)
 
-    # test for other types same spline
+    # For same curve, test other spline types
     assert np.allclose(bezier.bspline.integrate.volume(), expected_result)
     assert np.allclose(
         bezier.rationalbezier.integrate.volume(), expected_result
     )
     assert np.allclose(bezier.nurbs.integrate.volume(), expected_result)
 
-    # Check if equal after refinement
+    # Check if volume is equal after degree elevation
     bezier.elevate_degrees([0, 0, 0])
 
     assert np.allclose(bezier.integrate.volume(), expected_result)
@@ -177,6 +177,7 @@ def test_assertions(np_rng):
 def test_function_integration(np_rng):
     col1_factor = 2
 
+    # Define vector-valued constant function
     def volume_function(x):
         vf = np.ones((x.shape[0], 2))
         # scale it with a factor to get a different value
@@ -186,6 +187,7 @@ def volume_function(x):
     bezier = splinepy.Bezier(
         degrees=[1, 2], control_points=np_rng.random((6, 2))
     )
+    # Test function integration for constant functions
     assert np.allclose(
         [bezier.integrate.volume(), col1_factor * bezier.integrate.volume()],
         bezier.integrate.parametric_function(volume_function),