From 3ac1b53545ec06b06c79f80e0eec48a9086805de Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Sun, 19 Mar 2023 07:01:03 -0400 Subject: [PATCH 1/3] DOC: Suggest replacement --- doc/api/next_api_changes/deprecations/XXXXX-AL.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/api/next_api_changes/deprecations/XXXXX-AL.rst b/doc/api/next_api_changes/deprecations/XXXXX-AL.rst index 41a0c09bb22c..1d6d51498bf2 100644 --- a/doc/api/next_api_changes/deprecations/XXXXX-AL.rst +++ b/doc/api/next_api_changes/deprecations/XXXXX-AL.rst @@ -1,3 +1,4 @@ ``RendererAgg.tostring_rgb`` and ``FigureCanvasAgg.tostring_rgb`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -... are deprecated with no replacement. +These have no direct replacement. Consider using ``tostring_argb`` instead, +which should cover most use cases. From 040813d2241ca95a90659417e3c814998c4db387 Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Mon, 20 Mar 2023 14:22:29 -0400 Subject: [PATCH 2/3] DOC: Better doc --- doc/api/next_api_changes/deprecations/XXXXX-AL.rst | 4 ++-- lib/matplotlib/backends/backend_agg.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/api/next_api_changes/deprecations/XXXXX-AL.rst b/doc/api/next_api_changes/deprecations/XXXXX-AL.rst index 1d6d51498bf2..d6989dcea25f 100644 --- a/doc/api/next_api_changes/deprecations/XXXXX-AL.rst +++ b/doc/api/next_api_changes/deprecations/XXXXX-AL.rst @@ -1,4 +1,4 @@ ``RendererAgg.tostring_rgb`` and ``FigureCanvasAgg.tostring_rgb`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -These have no direct replacement. Consider using ``tostring_argb`` instead, -which should cover most use cases. +... are deprecated with no direct replacement. Consider using ``buffer_rgba`` +instead, which should cover most use cases. diff --git a/lib/matplotlib/backends/backend_agg.py b/lib/matplotlib/backends/backend_agg.py index 3d7dfa57a82e..179a00ac64bc 100644 --- a/lib/matplotlib/backends/backend_agg.py +++ b/lib/matplotlib/backends/backend_agg.py @@ -280,7 +280,7 @@ def buffer_rgba(self): def tostring_argb(self): return np.asarray(self._renderer).take([3, 0, 1, 2], axis=2).tobytes() - @_api.deprecated("3.8") + @_api.deprecated("3.8", alternative="buffer_rgba") def tostring_rgb(self): return np.asarray(self._renderer).take([0, 1, 2], axis=2).tobytes() @@ -415,7 +415,7 @@ def get_renderer(self, cleared=False): self.renderer.clear() return self.renderer - @_api.deprecated("3.8") + @_api.deprecated("3.8", alternative="buffer_rgba") def tostring_rgb(self): """ Get the image as RGB `bytes`. From cca1cbd89f88825b7e3e263c68373e5e0a8f90fa Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Tue, 21 Mar 2023 15:21:38 -0400 Subject: [PATCH 3/3] DOC: Move --- .../next_api_changes/deprecations/{XXXXX-AL.rst => 25484-AL.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/api/next_api_changes/deprecations/{XXXXX-AL.rst => 25484-AL.rst} (100%) diff --git a/doc/api/next_api_changes/deprecations/XXXXX-AL.rst b/doc/api/next_api_changes/deprecations/25484-AL.rst similarity index 100% rename from doc/api/next_api_changes/deprecations/XXXXX-AL.rst rename to doc/api/next_api_changes/deprecations/25484-AL.rst