Deprecated the set_colorbar method on a scalar mappable. #2055
Conversation
| 'set the colorbar image and axes associated with mappable' | ||
| self.colorbar = im, ax | ||
| """set the colorbar and axes instances associated with mappable""" | ||
| self.colorbar = im |
There was a problem hiding this comment.
I must have missed some other PR... there weren't any old code that would have queried and expected a tuple from the colorbar attribute, right?
There was a problem hiding this comment.
No. I don't think anything is making use of it (at least, there are no tests which exercise it, and a thorough grepping didn't throw anything up)
|
It looks like part of the point here is that a colorbar always has an axes attribute, so there is no need for a tuple in the ScalarMappable colorbar attribute. Looks like a good cleanup--but it is a bit dangerous, and I don't know how to handle that. The danger, of course, is that some user code is expecting the attribute to hold a tuple. Maybe it will be adequate to simply flag this prominently in the description of API changes. |
Agreed. Indeed I have code which does |
|
Think this is good to go. |
Deprecated the set_colorbar method on a scalar mappable.
| of ``(colorbar_instance, colorbar_axes)`` but is now just | ||
| ``colorbar_instance``. To get the colorbar axes it is possible to just use | ||
| the :attr:`~matplotlib.colorbar.ColorbarBase.ax` attribute on a colorbar | ||
| isntance. |
There was a problem hiding this comment.
No worries. We can just push that fix directly to master.
|
As a note, since this is a backwards incompatible change, should the next version number be |
|
Since 1.0, we have allowed backward incompatible changes of this magnitude for minor point releases, with a note in |
Deprecated in matplotlib#2055 / 148ed82
Deprecated in matplotlib#2055 / 148ed82
Deprecated in matplotlib#2055 / 148ed82
Deprecated in matplotlib#2055 / 148ed82
Deprecated in matplotlib#2055 / 148ed82
No description provided.