Reparametrize offsetbox calculations in terms of bboxes. #24465
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2a8b34b to
9364728
Compare
oscargus
reviewed
Nov 18, 2022
Passing a single bbox instead of (xdescent, ydescent, width, height) separately is easier to follow (see e.g. the changes in VPacker and HPacker, which no longer have to repeatedly pack/unpack whd_list), and avoids having to figure out e.g. the sign of the descents and whether width/height includes the descents, for example. Currently get_offset keeps a back compatible signature (we *could* consider killing the old signature but let's not do that for now), and _get_bbox_and_child_offsets is private because I *may* want to later also change the convention to make offsets relative to the bbox (0, 0) point rather than the bbox lower-left corner.
tacaswell
approved these changes
Dec 15, 2022
ksunden
reviewed
Dec 21, 2022
|
|
||
| @functools.wraps(meth) | ||
| def get_offset(self, *args, **kwargs): | ||
| params = _api.select_matching_signature(sigs, self, *args, **kwargs) |
There was a problem hiding this comment.
Should probably warn if the old signature is used, select_matching_signature does not do so itself.
There was a problem hiding this comment.
I intentionally chose not to deprecate anything yet as I think we can live at least with one release supporting both apis to make sure the new one makes sense?
ksunden
approved these changes
Dec 23, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that ca
3138
n be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Passing a single bbox instead of (xdescent, ydescent, width, height) separately is easier to follow (see e.g. the changes in VPacker and HPacker, which no longer have to repeatedly pack/unpack whd_list), and avoids having to figure out e.g. the sign of the descents and whether width/height includes the descents, for example.
Currently get_offset keeps a backcompatible signature (we could consider killing the old signature but let's not do that for now), and _get_bbox_and_child_offsets is private because I may want to later also change the convention to make offsets relative to the bbox (0, 0) point rather than the bbox lower-left corner.
PR Summary
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst