From 27d64d9e6f7c0a7364b82af1700e62881faef1de Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Thu, 4 Feb 2021 22:29:44 +0100 Subject: [PATCH 1/2] Add note that pyplot cannot be used for 3D. Also: - remove the table of contents on that page. It's still available in the side bar and removing reduces the clutter in the main body. - slightly reword the note on maturity of 3D plotting (nobody needs to know that this was improved for 1.1.0) --- doc/api/toolkits/mplot3d.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/api/toolkits/mplot3d.rst b/doc/api/toolkits/mplot3d.rst index cfd914fa579a..4b48cbdf55a1 100644 --- a/doc/api/toolkits/mplot3d.rst +++ b/doc/api/toolkits/mplot3d.rst @@ -4,8 +4,11 @@ mplot3d API *********** -.. contents:: - :backlinks: none +.. note:: + `.pyplot` cannot be used to add content to 3D plots, because it's function + sigantures are strictly 2D and cannot handle the additional information + needed for 3D. Instead, use the explicit API by calling the respective + methods on the `.Axes3D` object. .. automodule:: mpl_toolkits.mplot3d :no-members: @@ -18,8 +21,7 @@ mplot3d API =================================== .. note:: - Significant effort went into bringing axes3d to feature-parity with - regular axes objects for version 1.1.0. However, more work remains. + 3D plotting in Matplotlib is still not as mature as the 2D case. Please report any functions that do not behave as expected as a bug. In addition, help and patches would be greatly appreciated! From bef6c13692269189faa28651b46b8e81934cd73f Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Fri, 5 Feb 2021 00:22:26 +0100 Subject: [PATCH 2/2] Update doc/api/toolkits/mplot3d.rst Co-authored-by: Elliott Sales de Andrade --- doc/api/toolkits/mplot3d.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/toolkits/mplot3d.rst b/doc/api/toolkits/mplot3d.rst index 4b48cbdf55a1..97d3bf13246f 100644 --- a/doc/api/toolkits/mplot3d.rst +++ b/doc/api/toolkits/mplot3d.rst @@ -5,8 +5,8 @@ mplot3d API *********** .. note:: - `.pyplot` cannot be used to add content to 3D plots, because it's function - sigantures are strictly 2D and cannot handle the additional information + `.pyplot` cannot be used to add content to 3D plots, because its function + signatures are strictly 2D and cannot handle the additional information needed for 3D. Instead, use the explicit API by calling the respective methods on the `.Axes3D` object.