Expand docstring for delete()

svalinn · May 2, 2024 · 71619e3 · 71619e3
1 parent 821fb6d
commit 71619e3
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/dagmc/dagnav.py b/dagmc/dagnav.py
@@ -369,7 +369,11 @@ def get_triangle_coordinate_mapping(self, compress=False):
         return tri_map, coords
 
     def delete(self):
-        """Delete this set from the DAGMC file."""
+        """Delete this set from the MOAB database, but doesn't
+        delete this DAGSet object.  The object remains but no
+        longer refers to anything in the model.  In many cases, it may
+        make sense to delete this DAGSet object immediately following
+        this operation."""
         self.model.used_ids[type(self)].discard(self.id)
         self.model.mb.delete_entity(self.handle)
         self.handle = None