update docstring for Mesh.add_nodes

Author: mcflugen

src/addon/esmpy/src/esmpy/api/mesh.py

@@ -495,6 +495,13 @@ def add_nodes(self, node_count,
             tuples into a numpy array that correspond to node_ids.
         :param ndarray node_owners: a numpy array of shape (node_count, 1) to
             specify the rank of the processor that owns each node.
+
+        *OPTIONAL:*
+
+        :param ndarray node_mask: a numpy array of shape
+            ``(node_count, 1)`` containing integer values to specify masked
+            nodes. The specific values that are masked are specified in the
+            :class:`~esmpy.api.regrid.Regrid` constructor.
         """
 
         self._node_count = node_count

src/addon/esmpy/src/esmpy/test/test_api/test_mesh.py

@@ -32,6 +32,7 @@
     ),
 )
 def test_add_nodes_with_mask(mask_value):
+    """Check adding masked nodes to a mesh."""
     if mask_value is None:
         mask = None
     else:
@@ -57,6 +58,7 @@ def test_add_nodes_with_mask(mask_value):
 
 
 def test_add_nodes_with_mask_bad():
+    """Check that adding a mask with an incorrect size raises an error."""
     mesh = Mesh(parametric_dim=2, spatial_dim=2, coord_sys=CoordSys.CART)
 
     x_of_points, y_of_points = np.meshgrid([0.0, 1.0, 2.0, 3.0], [0.0, 1.0, 2.0])

src/addon/esmpy/src/esmpy/test/test_api/test_regrid.py

@@ -143,6 +143,7 @@ def test_regrid_with_const_node_mask(mask_value, method):
 )
 @pytest.mark.parametrize("method", NON_CONSERVATIVE_METHODS)
 def test_regrid_with_node_mask(mask, method):
+    """Check that unmasked nodes are regridded and masked nodes remain unchanged."""
     src = create_raster_field([0.0, 1.0, 2.0, 3.0], [0.0, 1.0, 2.0], node_mask=mask)
     dst = create_raster_field([0.0, 1.0, 2.0, 3.0], [0.0, 1.0, 2.0], node_mask=mask)
     src.data[:] = 100.0
@@ -168,6 +169,7 @@ def test_regrid_with_node_mask(mask, method):
 
 @pytest.mark.parametrize("method", NON_CONSERVATIVE_METHODS)
 def test_regrid_with_random_node_mask(method):
+    """Check regridding that masks random input data."""
     n_rows, n_cols = 100, 200
 
     src_data = np.random.uniform(-1.0, 1.0, size=n_rows * n_cols)
@@ -201,6 +203,7 @@ def test_regrid_with_random_node_mask(method):
 
 @pytest.mark.parametrize("method", NON_CONSERVATIVE_METHODS)
 def test_regrid_with_multivalued_node_mask(method):
+    """Check regridding that masks multiple values."""
     n_rows, n_cols = 100, 200
 
     src_data = np.random.uniform(-1.0, 1.0, size=n_rows * n_cols)