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

Fix invalid range validators. #25843

Merged
merged 1 commit into from May 10, 2023
Merged

Fix invalid range validators. #25843

merged 1 commit into from May 10, 2023

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented May 9, 2023

  • The correct bound on margins value, documented in set_x/y/zmargin, is margin>-0.5. Fix the docstring of margins() and the rc validators.
  • The only constraints on tight/constrained layout margins is left<right and bottom<top, but values outside of [0, 1] can in fact be valid. It would be annoying to enforce this at the rcparams level (this would force the user to update individual rcparams in a careful order), so just don't bother validating the values beyond "float". (See discussion at Group figure.subplot.* rc to a single rcParam. #11231 (comment))
  • Remove the somewhat overengineered _range_validators.
  • Move the comment about the values of figure.constrained_layout.h/w_pad to the default matplotlibrc (in rcsetup.py it was far away from the actual values, which made things a bit weird). Also reword a bit.

PR summary

PR checklist

lib/matplotlib/rcsetup.py Outdated Show resolved Hide resolved
- The correct bound on margins value, documented in set_x/y/zmargin, is
  margin>-0.5.  Fix the docstring of margins() and the rc validators.
- The only constraints on tight/constrained layout margins is left<right
  and bottom<top, but values outside of [0, 1] can in fact be valid.  It
  would be annoying to enforce this at the rcparams level (this would
  force the user to update individual rcparams in a careful order), so
  just don't bother validating the values beyond "float".
- Remove the somewhat overengineered _range_validators.
- Move the comment about the values of figure.constrained_layout.h/w_pad
  to the default matplotlibrc (in rcsetup.py it was far away from the
  actual values, which made things a bit weird).  Also reword a bit.
@timhoffm timhoffm added this to the v3.8.0 milestone May 10, 2023
@timhoffm timhoffm merged commit 04586cd into matplotlib:main May 10, 2023
36 of 39 checks passed
@anntzer anntzer deleted the rv branch May 10, 2023 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants