Skip to content

Commit

Permalink
Merge pull request #24109 from jklymak/doc-add-API-note-colorbar-issue
Browse files Browse the repository at this point in the history
DOC: add API change note for colorbar deprecation
  • Loading branch information
QuLogic committed Oct 7, 2022
2 parents eb44018 + 176fc99 commit 91093a2
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/api/next_api_changes/deprecations/24088-JMK.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Colorbars for orphaned mappables are deprecated, but no longer raise
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Before 3.6.0, Colorbars for mappables that do not have a parent axes would
steal space from the current Axes. 3.6.0 raised an error on this, but without
a deprecation cycle. For 3.6.1 this is reverted, the current axes is used,
but a deprecation warning is shown instead. In this undetermined case users
and libraries should explicitly specify what axes they want space to be stolen
from: ``fig.colorbar(mappable, ax=plt.gca())``.

0 comments on commit 91093a2

Please sign in to comment.