Skip to content

Fix invalid range validators. - #25843

Merged
timhoffm merged 1 commit into
matplotlib:mainfrom
anntzer:rv
May 10, 2023
Merged

timhoffm merged 1 commit into
matplotlib:mainfrom
anntzer:rv

Conversation

@anntzer

@anntzer anntzer commented May 9, 2023

Copy link
Copy Markdown
Contributor
  • 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

@anntzer anntzer added topic: rcparams API: argument checking Validation of acceptable argument values labels May 9, 2023
Comment thread lib/matplotlib/rcsetup.py 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
@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

Labels

API: argument checking Validation of acceptable argument values topic: rcparams

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants