From c33949bcb65ee3c35911fe32a98d556c462d6084 Mon Sep 17 00:00:00 2001 From: Oscar Gustafsson Date: Fri, 16 Sep 2022 09:50:18 +0200 Subject: [PATCH] Edit mplot3d examples for correctness and consistency --- examples/mplot3d/2dcollections3d.py | 2 +- examples/mplot3d/contour3d.py | 6 +++--- examples/mplot3d/contour3d_2.py | 8 ++++---- examples/mplot3d/contourf3d.py | 8 ++++---- examples/mplot3d/hist3d.py | 2 +- examples/mplot3d/lines3d.py | 2 +- examples/mplot3d/lorenz_attractor.py | 2 +- examples/mplot3d/mixed_subplots.py | 6 +++--- examples/mplot3d/offset.py | 2 +- examples/mplot3d/rotate_axes3d_sgskip.py | 2 +- examples/mplot3d/surface3d.py | 4 ++-- examples/mplot3d/text3d.py | 8 ++++---- examples/mplot3d/trisurf3d_2.py | 2 +- examples/mplot3d/voxels_numpy_logo.py | 2 +- examples/mplot3d/voxels_rgb.py | 2 +- examples/mplot3d/wire3d_animation_sgskip.py | 6 +++--- examples/mplot3d/wire3d_zero_stride.py | 2 +- 17 files changed, 33 insertions(+), 33 deletions(-) diff --git a/examples/mplot3d/2dcollections3d.py b/examples/mplot3d/2dcollections3d.py index 5760d429775e..96183ddb9912 100644 --- a/examples/mplot3d/2dcollections3d.py +++ b/examples/mplot3d/2dcollections3d.py @@ -3,7 +3,7 @@ Plot 2D data on 3D plot ======================= -Demonstrates using ax.plot's zdir keyword to plot 2D data on +Demonstrates using ax.plot's *zdir* keyword to plot 2D data on selective axes of a 3D plot. """ diff --git a/examples/mplot3d/contour3d.py b/examples/mplot3d/contour3d.py index 2b0a2872d0cc..7b96980e3a73 100644 --- a/examples/mplot3d/contour3d.py +++ b/examples/mplot3d/contour3d.py @@ -1,7 +1,7 @@ """ -================================================== -Demonstrates plotting contour (level) curves in 3D -================================================== +================================= +Plot contour (level) curves in 3D +================================= This is like a contour plot in 2D except that the ``f(x, y)=c`` curve is plotted on the plane ``z=c``. diff --git a/examples/mplot3d/contour3d_2.py b/examples/mplot3d/contour3d_2.py index b6478bc79142..6dbc62eb9427 100644 --- a/examples/mplot3d/contour3d_2.py +++ b/examples/mplot3d/contour3d_2.py @@ -1,9 +1,9 @@ """ -============================================================================ -Demonstrates plotting contour (level) curves in 3D using the extend3d option -============================================================================ +=========================================================== +Plot contour (level) curves in 3D using the extend3d option +=========================================================== -This modification of the contour3d_demo example uses extend3d=True to +This modification of the :doc:`contour3d` example uses ``extend3d=True`` to extend the curves vertically into 'ribbons'. """ diff --git a/examples/mplot3d/contourf3d.py b/examples/mplot3d/contourf3d.py index c15ecdcfd6c0..6f0261ad0908 100644 --- a/examples/mplot3d/contourf3d.py +++ b/examples/mplot3d/contourf3d.py @@ -3,11 +3,11 @@ Filled contours =============== -contourf differs from contour in that it creates filled contours, ie. -a discrete number of colours are used to shade the domain. +`.Axes3D.contourf` differs from `.Axes3D.contour` in that it creates filled +contours, i.e. a discrete number of colours are used to shade the domain. -This is like a contourf plot in 2D except that the shaded region corresponding -to the level c is graphed on the plane z=c. +This is like a `.Axes.contourf` plot in 2D except that the shaded region +corresponding to the level c is graphed on the plane ``z=c``. """ from mpl_toolkits.mplot3d import axes3d diff --git a/examples/mplot3d/hist3d.py b/examples/mplot3d/hist3d.py index 6577a010c14a..e602f7f1e6c5 100644 --- a/examples/mplot3d/hist3d.py +++ b/examples/mplot3d/hist3d.py @@ -3,7 +3,7 @@ Create 3D histogram of 2D data ============================== -Demo of a histogram for 2 dimensional data as a bar graph in 3D. +Demo of a histogram for 2D data as a bar graph in 3D. """ import matplotlib.pyplot as plt diff --git a/examples/mplot3d/lines3d.py b/examples/mplot3d/lines3d.py index f7578d8657b4..c974bcbdff8d 100644 --- a/examples/mplot3d/lines3d.py +++ b/examples/mplot3d/lines3d.py @@ -1,6 +1,6 @@ """ ================ -Parametric Curve +Parametric curve ================ This example demonstrates plotting a parametric curve in 3D. diff --git a/examples/mplot3d/lorenz_attractor.py b/examples/mplot3d/lorenz_attractor.py index 7162c12d2dce..aad08a16439e 100644 --- a/examples/mplot3d/lorenz_attractor.py +++ b/examples/mplot3d/lorenz_attractor.py @@ -1,6 +1,6 @@ """ ================ -Lorenz Attractor +Lorenz attractor ================ This is an example of plotting Edward Lorenz's 1963 `"Deterministic Nonperiodic diff --git a/examples/mplot3d/mixed_subplots.py b/examples/mplot3d/mixed_subplots.py index df981ceee4ea..1ab91278a1d9 100644 --- a/examples/mplot3d/mixed_subplots.py +++ b/examples/mplot3d/mixed_subplots.py @@ -1,7 +1,7 @@ """ -================================= -2D and 3D *Axes* in same *Figure* -================================= +============================= +2D and 3D axes in same figure +============================= This example shows a how to plot a 2D and 3D plot on the same figure. """ diff --git a/examples/mplot3d/offset.py b/examples/mplot3d/offset.py index 56a14d69fa98..00adcc2f236d 100644 --- a/examples/mplot3d/offset.py +++ b/examples/mplot3d/offset.py @@ -1,6 +1,6 @@ """ ========================= -Automatic Text Offsetting +Automatic text offsetting ========================= This example demonstrates mplot3d's offset text display. diff --git a/examples/mplot3d/rotate_axes3d_sgskip.py b/examples/mplot3d/rotate_axes3d_sgskip.py index 8d27873c3b74..8967277ea5d7 100644 --- a/examples/mplot3d/rotate_axes3d_sgskip.py +++ b/examples/mplot3d/rotate_axes3d_sgskip.py @@ -3,7 +3,7 @@ Rotating a 3D plot ================== -A very simple animation of a rotating 3D plot about all 3 axes. +A very simple animation of a rotating 3D plot about all three axes. See :doc:`wire3d_animation_sgskip` for another example of animating a 3D plot. diff --git a/examples/mplot3d/surface3d.py b/examples/mplot3d/surface3d.py index 6a82631fc1ed..07019cb15e31 100644 --- a/examples/mplot3d/surface3d.py +++ b/examples/mplot3d/surface3d.py @@ -4,9 +4,9 @@ ===================== Demonstrates plotting a 3D surface colored with the coolwarm colormap. -The surface is made opaque by using antialiased=False. +The surface is made opaque by using ``antialiased=False``. -Also demonstrates using the LinearLocator and custom formatting for the +Also demonstrates using the `.LinearLocator` and custom formatting for the z axis tick labels. """ diff --git a/examples/mplot3d/text3d.py b/examples/mplot3d/text3d.py index 7f6a2858eb1f..922d161a9f89 100644 --- a/examples/mplot3d/text3d.py +++ b/examples/mplot3d/text3d.py @@ -7,10 +7,10 @@ Functionality shown: -- Using the text function with three types of 'zdir' values: None, an axis - name (ex. 'x'), or a direction tuple (ex. (1, 1, 0)). -- Using the text function with the color keyword. -- Using the text2D function to place text on a fixed position on the ax +- Using the `~.Axes3D.text` function with three types of *zdir* values: None, + an axis name (ex. 'x'), or a direction tuple (ex. (1, 1, 0)). +- Using the `~.Axes3D.text` function with the color keyword. +- Using the `.text2D` function to place text on a fixed position on the ax object. """ diff --git a/examples/mplot3d/trisurf3d_2.py b/examples/mplot3d/trisurf3d_2.py index 728698b7af69..8ed354d5e5e6 100644 --- a/examples/mplot3d/trisurf3d_2.py +++ b/examples/mplot3d/trisurf3d_2.py @@ -6,7 +6,7 @@ Two additional examples of plotting surfaces with triangular mesh. The first demonstrates use of plot_trisurf's triangles argument, and the -second sets a Triangulation object's mask and passes the object directly +second sets a `.Triangulation` object's mask and passes the object directly to plot_trisurf. """ diff --git a/examples/mplot3d/voxels_numpy_logo.py b/examples/mplot3d/voxels_numpy_logo.py index 8b790d073988..34eb48dcbe8a 100644 --- a/examples/mplot3d/voxels_numpy_logo.py +++ b/examples/mplot3d/voxels_numpy_logo.py @@ -1,6 +1,6 @@ """ =============================== -3D voxel plot of the numpy logo +3D voxel plot of the NumPy logo =============================== Demonstrates using `.Axes3D.voxels` with uneven coordinates. diff --git a/examples/mplot3d/voxels_rgb.py b/examples/mplot3d/voxels_rgb.py index 31bfcbca15a9..da27ad11f752 100644 --- a/examples/mplot3d/voxels_rgb.py +++ b/examples/mplot3d/voxels_rgb.py @@ -1,6 +1,6 @@ """ ========================================== -3D voxel / volumetric plot with rgb colors +3D voxel / volumetric plot with RGB colors ========================================== Demonstrates using `.Axes3D.voxels` to visualize parts of a color space. diff --git a/examples/mplot3d/wire3d_animation_sgskip.py b/examples/mplot3d/wire3d_animation_sgskip.py index b4f681e778f5..bfc76661ffd0 100644 --- a/examples/mplot3d/wire3d_animation_sgskip.py +++ b/examples/mplot3d/wire3d_animation_sgskip.py @@ -1,7 +1,7 @@ """ -============================= -Animating a 3D wireframe plot -============================= +=========================== +Animate a 3D wireframe plot +=========================== A very simple "animation" of a 3D plot. See also :doc:`rotate_axes3d_sgskip`. diff --git a/examples/mplot3d/wire3d_zero_stride.py b/examples/mplot3d/wire3d_zero_stride.py index 1ba406b753f4..f4c679300820 100644 --- a/examples/mplot3d/wire3d_zero_stride.py +++ b/examples/mplot3d/wire3d_zero_stride.py @@ -3,7 +3,7 @@ 3D wireframe plots in one direction =================================== -Demonstrates that setting rstride or cstride to 0 causes wires to not be +Demonstrates that setting *rstride* or *cstride* to 0 causes wires to not be generated in the corresponding direction. """ pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy