updated docstring in the size_by arg to point out that the size is ma…

…rker area
AlemSnyder · Jun 21, 2023 · ff9c8fe · ff9c8fe
1 parent f02be9d
commit ff9c8fe
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/openpnm/visualization/_plottools.py b/openpnm/visualization/_plottools.py
@@ -208,7 +208,9 @@ def plot_coordinates(network,
         well as throat connections from ``plot_connections``.
     size_by : str or array_like
         An ndarray of pore values (e.g. alg['pore.concentration']). These
-        values are normalized by scaled by ``markersize``.
+        values are normalized by scaled by ``markersize``.  Note that this controls
+        the marker *area*, so if you want the markers to be proportional to diameter
+        you should do `size_by=net['pore.diameter']**2`.
     color_by : str or array_like
         An ndarray of pore values (e.g. alg['pore.concentration']).
     cmap : str or cmap object