diff options
author | Thomas A Caswell <tcaswell@gmail.com> | 2017-07-16 14:02:37 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-07-16 14:02:37 -0500 |
commit | 63744d59c4bf999a0ba7bd5b7f7080f830aedeb7 (patch) | |
tree | 10181e1cbea82fd5caf783acdccf628e08991206 | |
parent | 9dd0db61a7706844603ca7653856a13022f65541 (diff) | |
parent | 010808692c449806b7a9c01ceb9729fb74f37189 (diff) |
DOC: Add one-line descriptions to 19 examples currently missing them
19 files changed, 25 insertions, 7 deletions
diff --git a/examples/animation/image_slices_viewer.py b/examples/animation/image_slices_viewer.py index 70646973e..de0d73523 100644 --- a/examples/animation/image_slices_viewer.py +++ b/examples/animation/image_slices_viewer.py @@ -3,6 +3,7 @@ Image Slices Viewer =================== +This example demonstrates how to scroll through 2D image slices of a 3D array. """ from __future__ import print_function diff --git a/examples/images_contours_and_fields/contourf_demo.py b/examples/images_contours_and_fields/contourf_demo.py index 496a8b321..e719a2655 100644 --- a/examples/images_contours_and_fields/contourf_demo.py +++ b/examples/images_contours_and_fields/contourf_demo.py @@ -3,6 +3,7 @@ Contourf Demo ============= +How to use the ``contourf`` function to create filled contour plots. """ import numpy as np import matplotlib.pyplot as plt diff --git a/examples/images_contours_and_fields/contourf_hatching.py b/examples/images_contours_and_fields/contourf_hatching.py index e28a64a88..9d4321008 100644 --- a/examples/images_contours_and_fields/contourf_hatching.py +++ b/examples/images_contours_and_fields/contourf_hatching.py @@ -3,6 +3,7 @@ Contourf Hatching ================= +Demo filled contour plots with hatched patterns. """ import matplotlib.pyplot as plt import numpy as np @@ -29,7 +30,6 @@ cs = plt.contourf(x, y, z, hatches=['-', '/', '\\', '//'], ) plt.colorbar() - # --------------------------------------------- # | Plot #2 | # --------------------------------------------- diff --git a/examples/pylab_examples/agg_buffer_to_array.py b/examples/pylab_examples/agg_buffer_to_array.py index 3662fc327..e254a6855 100644 --- a/examples/pylab_examples/agg_buffer_to_array.py +++ b/examples/pylab_examples/agg_buffer_to_array.py @@ -3,6 +3,7 @@ Agg Buffer To Array =================== +Convert a rendered figure to its image (NumPy array) representation. """ import matplotlib.pyplot as plt import numpy as np diff --git a/examples/pylab_examples/axes_demo.py b/examples/pylab_examples/axes_demo.py index e57496522..36b23d2c7 100644 --- a/examples/pylab_examples/axes_demo.py +++ b/examples/pylab_examples/axes_demo.py @@ -3,6 +3,7 @@ Axes Demo ========= +Example use of ``plt.axes`` to create inset axes within the main plot axes. """ import matplotlib.pyplot as plt import numpy as np diff --git a/examples/pylab_examples/axhspan_demo.py b/examples/pylab_examples/axhspan_demo.py index c9cbf3d81..8e9eac28c 100644 --- a/examples/pylab_examples/axhspan_demo.py +++ b/examples/pylab_examples/axhspan_demo.py @@ -3,6 +3,7 @@ Axhspan Demo ============ +Create lines or rectangles that span the axes in either the horizontal or vertical direction. """ import numpy as np import matplotlib.pyplot as plt diff --git a/examples/pylab_examples/axis_equal_demo.py b/examples/pylab_examples/axis_equal_demo.py index 4b5d928bc..568b89966 100644 --- a/examples/pylab_examples/axis_equal_demo.py +++ b/examples/pylab_examples/axis_equal_demo.py @@ -3,6 +3,7 @@ Axis Equal Demo =============== +How to set and adjust plots with equal axis ratios. """ import matplotlib.pyplot as plt diff --git a/examples/pylab_examples/figure_title.py b/examples/pylab_examples/figure_title.py index cd8d6023f..c4c2408b9 100644 --- a/examples/pylab_examples/figure_title.py +++ b/examples/pylab_examples/figure_title.py @@ -3,6 +3,7 @@ Figure Title ============ +Create a figure with separate subplot titles and a centered figure title. """ from matplotlib.font_manager import FontProperties import matplotlib.pyplot as plt diff --git a/examples/pylab_examples/fill_betweenx_demo.py b/examples/pylab_examples/fill_betweenx_demo.py index 7b827004a..660cdc155 100644 --- a/examples/pylab_examples/fill_betweenx_demo.py +++ b/examples/pylab_examples/fill_betweenx_demo.py @@ -3,6 +3,7 @@ Fill Betweenx Demo ================== +Using ``fill_betweenx`` to color between two horizontal curves. """ import matplotlib.mlab as mlab from matplotlib.pyplot import figure, show diff --git a/examples/pylab_examples/log_demo.py b/examples/pylab_examples/log_demo.py index d80bcc282..8ca93b72c 100644 --- a/examples/pylab_examples/log_demo.py +++ b/examples/pylab_examples/log_demo.py @@ -3,6 +3,7 @@ Log Demo ======== +Examples of plots with logarithmic axes. """ import numpy as np diff --git a/examples/pylab_examples/plotfile_demo.py b/examples/pylab_examples/plotfile_demo.py index 78bd61eb2..b927b4870 100644 --- a/examples/pylab_examples/plotfile_demo.py +++ b/examples/pylab_examples/plotfile_demo.py @@ -3,6 +3,7 @@ Plotfile Demo ============= +Example use of ``plotfile`` to plot data directly from a file. """ import matplotlib.pyplot as plt import numpy as np diff --git a/examples/pylab_examples/polar_legend.py b/examples/pylab_examples/polar_legend.py index 7bf24e9b5..8316c3db1 100644 --- a/examples/pylab_examples/polar_legend.py +++ b/examples/pylab_examples/polar_legend.py @@ -3,6 +3,7 @@ Polar Legend ============ +Demo of a legend on a polar-axis plot. """ import numpy as np from matplotlib.pyplot import figure, show, rc diff --git a/examples/pylab_examples/simple_plot.py b/examples/pylab_examples/simple_plot.py index 29d48bee7..6a375ebbe 100644 --- a/examples/pylab_examples/simple_plot.py +++ b/examples/pylab_examples/simple_plot.py @@ -3,6 +3,7 @@ Simple Plot =========== +Create a simple plot. """ import matplotlib.pyplot as plt import numpy as np diff --git a/examples/pylab_examples/specgram_demo.py b/examples/pylab_examples/specgram_demo.py index 0a2f04ab9..4c0a45098 100644 --- a/examples/pylab_examples/specgram_demo.py +++ b/examples/pylab_examples/specgram_demo.py @@ -1,8 +1,9 @@ """ -============= -Specgram Demo -============= +================ +Spectrogram Demo +================ +Demo of a spectrogram plot. """ import matplotlib.pyplot as plt import numpy as np diff --git a/examples/pylab_examples/spine_placement_demo.py b/examples/pylab_examples/spine_placement_demo.py index 3dc6b1f28..d67a60f86 100644 --- a/examples/pylab_examples/spine_placement_demo.py +++ b/examples/pylab_examples/spine_placement_demo.py @@ -3,6 +3,7 @@ Spine Placement Demo ==================== +Adjusting the location and appearance of axis spines. """ import numpy as np import matplotlib.pyplot as plt diff --git a/examples/pylab_examples/stem_plot.py b/examples/pylab_examples/stem_plot.py index e6bca72f5..20b8c9f9d 100644 --- a/examples/pylab_examples/stem_plot.py +++ b/examples/pylab_examples/stem_plot.py @@ -3,6 +3,7 @@ Stem Plot ========= +Example stem plot. """ import matplotlib.pyplot as plt import numpy as np diff --git a/examples/pylab_examples/step_demo.py b/examples/pylab_examples/step_demo.py index 63679e73c..35da17e49 100644 --- a/examples/pylab_examples/step_demo.py +++ b/examples/pylab_examples/step_demo.py @@ -3,6 +3,7 @@ Step Demo ========= +Example step plots. """ import numpy as np from numpy import ma diff --git a/examples/pylab_examples/symlog_demo.py b/examples/pylab_examples/symlog_demo.py index 577d399e5..c655e6347 100644 --- a/examples/pylab_examples/symlog_demo.py +++ b/examples/pylab_examples/symlog_demo.py @@ -3,6 +3,7 @@ Symlog Demo =========== +Example use of symlog (symmetric log) axis scaling. """ import matplotlib.pyplot as plt import numpy as np diff --git a/examples/pylab_examples/xcorr_demo.py b/examples/pylab_examples/xcorr_acorr_demo.py index ab182fb74..d388e3849 100644 --- a/examples/pylab_examples/xcorr_demo.py +++ b/examples/pylab_examples/xcorr_acorr_demo.py @@ -1,8 +1,9 @@ """ -========== -Xcorr Demo -========== +================================ +Cross- and Auto-Correlation Demo +================================ +Example use of cross-correlation (``xcorr``) and auto-correlation (``acorr``) plots. """ import matplotlib.pyplot as plt import numpy as np |