Skip to content

Commit 3a35019

Browse files
committed
plot_probe_gorup -> plot_probegroup
1 parent 0a85e41 commit 3a35019

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

src/probeinterface/plotting.py

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ def on_press(event):
183183
return poly, poly_contour
184184

185185

186-
def plot_probe_group(probegroup, same_axes: bool = True, **kargs):
186+
def plot_probegroup(probegroup, same_axes: bool = True, **kargs):
187187
"""Plot all probes from a ProbeGroup
188188
Can be in an existing set of axes or separate axes.
189189
@@ -244,6 +244,22 @@ def plot_probe_group(probegroup, same_axes: bool = True, **kargs):
244244
plot_probe(probe, ax=axs[i], **kargs)
245245

246246

247+
def plot_probe_group(probegroup, same_axes: bool = True, **kargs):
248+
"""
249+
This function is deprecated and will be removed in 0.2.23
250+
Please use plot_probegroup instead"""
251+
252+
from warnings import warn
253+
254+
warn(
255+
"`plot_probe_group` is deprecated and will be removed in 2.23. Use plot_probegroup instead",
256+
category=DeprecationWarning,
257+
stacklevel=2,
258+
)
259+
260+
plot_probegroup(probegroup, same_axes=same_axes, **kargs)
261+
262+
247263
def _on_press(probe, event):
248264
ax = event.inaxes
249265
x, y = event.xdata, event.ydata

0 commit comments

Comments
 (0)