Document and test _get_packed_offsets() #14516
Conversation
| @@ -81,6 +117,9 @@ def _get_packed_offsets(wd_list, total, sep, mode="fixed"): | |||
| elif mode == "equal": | |||
| maxh = max(w_list) | |||
| if total is None: | |||
| if sep is None: | |||
| raise ValueError("total and sep cannot both be None when " | |||
There was a problem hiding this comment.
This raised a TypeError before in the line below (int + None).
Since the function is private, we can do the change without announcement.
2b51e13 to
b40cef8
Compare
b40cef8 to
67af4a6
Compare
Co-Authored-By: Elliott Sales de Andrade <quantum.analyst@gmail.com>
| @@ -123,4 +125,58 @@ def test_get_packed_offsets(wd_list, total, sep, mode): | |||
| # issue tickets (at least #10476 and #10784) related to corner cases | |||
| # triggered inside this function when calling higher-level functions | |||
| # (e.g. `Axes.legend`). | |||
| # These are just some additional smoke tests. The output is untested. | |||
There was a problem hiding this comment.
It looks like this test could just be deleted as it is essentially covered by the tests below?
There was a problem hiding this comment.
Not exactly, e.g. I do not test negative total or sep. I agree that they'd better be tested explicitly for their output, but until then this is better than nothing.
Since it is not documented what should happen in this cases, I've left this as is (unresolved). IMHO that discussion is worth some thought and a separate PR.
| ---------- | ||
| wd_list : list of (float, float) | ||
| (width, xdescent) of boxes to be packed. | ||
| total : float or None |
There was a problem hiding this comment.
| total : float or None | |
| total : float or *None* |
There was a problem hiding this comment.
Generally, I don't think we style parameter types.
Co-Authored-By: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Co-Authored-By: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Co-Authored-By: Elliott Sales de Andrade <quantum.analyst@gmail.com>
PR Summary
Properly test and document
matplotlib.offsetbox._get_packed_offsets().PR Checklist