From 176fc99dc5d4020e810d7e4a75978f1a8c2653b3 Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Thu, 6 Oct 2022 18:46:05 -0700 Subject: [PATCH] DOC: add API change note for colorbar deprecation --- doc/api/next_api_changes/deprecations/24088-JMK.rst | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 doc/api/next_api_changes/deprecations/24088-JMK.rst diff --git a/doc/api/next_api_changes/deprecations/24088-JMK.rst b/doc/api/next_api_changes/deprecations/24088-JMK.rst new file mode 100644 index 000000000000..caa7e93a05b4 --- /dev/null +++ b/doc/api/next_api_changes/deprecations/24088-JMK.rst @@ -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())``.