Improving documentation on the return array of openmc.lib.id_map (#2630)

openmc-dev · Aug 5, 2023 · f9c17dd · f9c17dd
1 parent 557880a
commit f9c17dd
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/openmc/lib/plot.py b/openmc/lib/plot.py
@@ -229,7 +229,8 @@ def id_map(plot):
     -------
     id_map : numpy.ndarray
         A NumPy array with shape (vertical pixels, horizontal pixels, 3) of
-        OpenMC property ids with dtype int32
+        OpenMC property ids with dtype int32. The last dimension of the array
+        contains, in order, cell IDs, cell instances, and material IDs.
 
     """
     img_data = np.zeros((plot.v_res, plot.h_res, 3),