Vectorize and document simple_linear_interpolation. #9860
Conversation
lib/matplotlib/cbook/__init__.py
Outdated
| result[i::steps] = delta * i + a0 | ||
| result[steps::steps] = a1 | ||
| """ | ||
| Resample an array with ``steps - 1`` points between each original point. |
There was a problem hiding this comment.
suggestion: -> "between original point pairs." or "between consecutive original points."
lib/matplotlib/cbook/__init__.py
Outdated
| return result | ||
| Parameters | ||
| ---------- | ||
| a : shape ``(N, ...)`` array-like |
There was a problem hiding this comment.
I think this pretty much requires an array; it would fail with a list, and I think it would ignore the mask in a masked array.
Another question for my information: is this way of including shape info documented as standard, either in numpydoc or in our docs? If not, it might be easier to read and more concise with "array, (N, ...)". That way the kind of object comes first, followed by the additional shape info.
There was a problem hiding this comment.
A quick grep suggests that array, shape (...) is more common in the docs (and I agree it is more legible).
The previous implementation already required a to be an array so I don't think that's a problem.
a99b6e1 to
55c5a54
Compare
PR Summary
PR Checklist