amepproject / amep

The Active Matter Evaluation Package (AMEP) - a Python library for the analysis of particle-based and continuum simulation data of soft and active matter systems
https://amepproject.de/
GNU General Public License v3.0
12 stars 2 forks source link

FRQ: rename plot.box to plot.box_boundary #62

Open kay-ro opened 3 weeks ago

kay-ro commented 3 weeks ago

Proposed new feature or change:

The name of plot.box to plot the simulation box and plot.draw_box to plot an annotation box are very similar. To avoid confusion in the future, plot.box could be renamed to plot.box_boundary (analogous to the name of the box_boundary keyword in functions).

kay-ro commented 1 week 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.

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)