Adding doc string to annotate heatmap func

PMEAL · Sep 9, 2023 · 3acd13d · 3acd13d
1 parent bfb5c1a
commit 3acd13d
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/porespy/visualization/_funcs.py b/porespy/visualization/_funcs.py
@@ -16,7 +16,20 @@
 ]
 
 
-def annotate_heatmap(heatmap, ax, mask=None, fontdict={}):
+def annotate_heatmap(heatmap, ax=None, mask=None, fontdict={}):
+    r"""
+    Overlays text representation of pixel values within a 2D image
+
+    Parameters
+    ----------
+    heatmap : ndarray
+        A 2D array of numerical values
+    ax : matplotlib axis handle
+        The handle of the
+    """
+    if ax is None:
+        fig, ax = plt.subplots()
+        ax.pcolormesh(heatmap)
     im = heatmap
     font_kws = {
         'size': 10,