Don't pass unused xdescent to _get_packed_offsets. #24462
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
oscargus
approved these changes
Nov 15, 2022
timhoffm
approved these changes
Nov 15, 2022
| _Params( # total=None (implicit 1) | ||
| [(.1, 0)] * 3, total=None, sep=None, expected=(1, [0, .45, .9])), | ||
| [.1] * 3, total=None, sep=None, expected=(1, [0, .45, .9])), |
There was a problem hiding this comment.
Optional: Write out the list, which is a little more explicit:
Suggested change
| [.1] * 3, total=None, sep=None, expected=(1, [0, .45, .9])), | |
| [.1, .1, .1], total=None, sep=None, expected=(1, [0, .45, .9])), |
| assert result[0] == expected[0] | ||
| assert_allclose(result[1], expected[1]) | ||
|
|
||
|
|
||
| def test_get_packed_offsets_equal_total_none_sep_none(): | ||
| with pytest.raises(ValueError): | ||
| _get_packed_offsets([(1, 0)] * 3, total=None, sep=None, mode='equal') | ||
| _get_packed_offsets([1] * 3, total=None, sep=None, mode='equal') |
There was a problem hiding this comment.
as above
Suggested change
| _get_packed_offsets([1] * 3, total=None, sep=None, mode='equal') | |
| _get_packed_offsets([1, 1, 1], total=None, sep=None, mode='equal') |
| @pytest.mark.parametrize('wd_list', | ||
| ([(150, 1)], [(150, 1)]*3, [(0.1, 1)], [(0.1, 1)]*2)) | ||
| @pytest.mark.parametrize('widths', | ||
| ([150], [150]*3, [0.1], [0.1]*2)) |
There was a problem hiding this comment.
as above
Suggested change
| ([150], [150]*3, [0.1], [0.1]*2)) | |
| ([150], [150, 150, 150], [0.1], [0.1, 0.1])) |
Instead of passing a list of (widths, xdescents) where xdescent is unused, just pass a list of widths. This helper is private so we just need to adjust the call sites and tests with no deprecation. This patch is preliminary work for some further cleanup on the offsetbox module.
timhoffm
approved these changes
Nov 15, 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 can 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.
Instead of passing a list of (widths, xdescents) where xdescent is unused, just pass a list of widths. This helper is private so we just need to adjust the call sites and tests with no deprecation.
This patch is preliminary work for some further cleanup on the offsetbox module (somewhat motivated by #24386).
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