Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FRQ: simplify how to set the plot style in plot.style() #34

Open
3 tasks
kay-ro opened this issue Jun 3, 2024 · 0 comments
Open
3 tasks

FRQ: simplify how to set the plot style in plot.style() #34

kay-ro opened this issue Jun 3, 2024 · 0 comments
Labels
module: plot new feature New feature release: minor Issues that need to be addressed in a minor release status: to do Issues that someone needs to work on

Comments

@kay-ro
Copy link

kay-ro commented Jun 3, 2024

Proposed new feature or change:

The call of the amep.plot.style() function is different for whether the goal is to set an amep style or the default matplotlib style. To make this functionality more user-friendly, the labels for the styles can be simplified and one added for the default matplotlib style.
The following changes would simplify the usage:

  • "amep_latex" -> "latex"
  • "amep_standard" -> "standard"
  • mpl_default=True -> "matplotlib"

When updating the code in compliance with a minor release, please keep it backwards-compatible.
Additionally, prepare for a major release with the simplified call arguments by adding a note to the documentation:

.. note:: Deprecates in 2.0.0
          `mpl_default` will be removed in an upcoming major release. Please use "matplotlib".
          "amep_latex" and "amep_standard" will be removed. Please use "latex" and "standard" instead.
@kay-ro kay-ro added new feature New feature release: minor Issues that need to be addressed in a minor release module: plot labels Jun 3, 2024
@kay-ro kay-ro added this to the release v1.0.3 milestone Jun 3, 2024
@hechtprojects hechtprojects added the status: to do Issues that someone needs to work on label Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: plot new feature New feature release: minor Issues that need to be addressed in a minor release status: to do Issues that someone needs to work on
Projects
None yet
Development

No branches or pull requests

2 participants