Open kay-ro opened 1 month ago
Proposal:
to add this change as early as possible, add an additional function plot.box_boundary
with the same functionality as plot.box
. Additionally, include a deprecation notice and warning in plot.box
that this function will be removed in 2.0.0 and users should switch to plot.box_boundary
.
plot.box
and rename it to plot.box_boundary
plot.box
plot.box
example from amep.plot.style
warnings.simplefilter('always', PendingDeprecationWarning)
warnings.warn("The options <mpl_default: bool>, 'amep_latex' and 'amep_standard' will be removed in an upcoming major release. Please use the modes 'matplotlib', 'latex' and 'standard' instead.", PendingDeprecationWarning)
Proposed new feature or change:
The name of
plot.box
to plot the simulation box andplot.draw_box
to plot an annotation box are very similar. To avoid confusion in the future,plot.box
could be renamed toplot.box_boundary
(analogous to the name of thebox_boundary
keyword in functions).