From 31168cb0d6d1aa84edd2a0d484011003284fbc34 Mon Sep 17 00:00:00 2001 From: tonyyli Date: Sat, 15 Jul 2017 16:24:25 -0500 Subject: [PATCH 1/5] Add one-line descriptions to 19 examples currently missing them --- examples/animation/image_slices_viewer.py | 1 + examples/images_contours_and_fields/contourf_demo.py | 1 + examples/images_contours_and_fields/contourf_hatching.py | 2 ++ examples/pylab_examples/agg_buffer_to_array.py | 1 + examples/pylab_examples/axes_demo.py | 1 + examples/pylab_examples/axhspan_demo.py | 1 + examples/pylab_examples/axis_equal_demo.py | 1 + examples/pylab_examples/figure_title.py | 1 + examples/pylab_examples/fill_betweenx_demo.py | 1 + examples/pylab_examples/log_demo.py | 1 + examples/pylab_examples/plotfile_demo.py | 1 + examples/pylab_examples/polar_legend.py | 1 + examples/pylab_examples/simple_plot.py | 1 + examples/pylab_examples/specgram_demo.py | 1 + examples/pylab_examples/spine_placement_demo.py | 1 + examples/pylab_examples/stem_plot.py | 1 + examples/pylab_examples/step_demo.py | 1 + examples/pylab_examples/symlog_demo.py | 1 + examples/pylab_examples/xcorr_demo.py | 1 + 19 files changed, 20 insertions(+) diff --git a/examples/animation/image_slices_viewer.py b/examples/animation/image_slices_viewer.py index 70646973ec98..de0d73523b01 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 496a8b321564..4a89bf7755e4 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 ============= +Example use of 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 e28a64a886bd..05bcab765732 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 of filled contour plots with of hatched patterns. """ import matplotlib.pyplot as plt import numpy as np @@ -29,6 +30,7 @@ ) 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 3662fc327a96..e254a6855350 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 e57496522f4d..f200b7f4e1c1 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 c9cbf3d81a37..02ddb7e48adc 100644 --- a/examples/pylab_examples/axhspan_demo.py +++ b/examples/pylab_examples/axhspan_demo.py @@ -3,6 +3,7 @@ Axhspan Demo ============ +The example shows how to 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 4b5d928bc1fc..ec77b0817230 100644 --- a/examples/pylab_examples/axis_equal_demo.py +++ b/examples/pylab_examples/axis_equal_demo.py @@ -3,6 +3,7 @@ Axis Equal Demo =============== +This example 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 cd8d6023fe9c..575681cea06b 100644 --- a/examples/pylab_examples/figure_title.py +++ b/examples/pylab_examples/figure_title.py @@ -3,6 +3,7 @@ Figure Title ============ +Example use of `title` and `suptitle` to create subplot titles and a centered figure title, respectively. """ 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 7b827004ab2a..0958e260ac50 100644 --- a/examples/pylab_examples/fill_betweenx_demo.py +++ b/examples/pylab_examples/fill_betweenx_demo.py @@ -3,6 +3,7 @@ Fill Betweenx Demo ================== +This example shows how to use `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 d80bcc282593..8ca93b72ce6d 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 78bd61eb248a..3252835ed5c4 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 7bf24e9b54d4..8316c3db1e13 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 29d48bee7edf..8ea7bce5f5f1 100644 --- a/examples/pylab_examples/simple_plot.py +++ b/examples/pylab_examples/simple_plot.py @@ -3,6 +3,7 @@ Simple Plot =========== +Simple example of 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 0a2f04ab9677..b252c551b93b 100644 --- a/examples/pylab_examples/specgram_demo.py +++ b/examples/pylab_examples/specgram_demo.py @@ -3,6 +3,7 @@ Specgram 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 3dc6b1f281d9..cb24c76aa604 100644 --- a/examples/pylab_examples/spine_placement_demo.py +++ b/examples/pylab_examples/spine_placement_demo.py @@ -3,6 +3,7 @@ Spine Placement Demo ==================== +This example demos how to adjust 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 e6bca72f5488..20b8c9f9d780 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 63679e73cc90..35da17e49319 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 577d399e59fe..d2d07744332b 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 (symmetrical 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_demo.py index ab182fb7410c..5f48c74a2aea 100644 --- a/examples/pylab_examples/xcorr_demo.py +++ b/examples/pylab_examples/xcorr_demo.py @@ -3,6 +3,7 @@ Xcorr Demo ========== +Example use of cross-correlation (`xcorr`) and auto-correlation (`acorr`) plots. """ import matplotlib.pyplot as plt import numpy as np From 5dd0d017675aef8489c20e3c87816c0d816caf1c Mon Sep 17 00:00:00 2001 From: tonyyli Date: Sat, 15 Jul 2017 17:16:01 -0500 Subject: [PATCH 2/5] Address PR comments --- examples/images_contours_and_fields/contourf_demo.py | 2 +- examples/images_contours_and_fields/contourf_hatching.py | 4 +--- examples/pylab_examples/axes_demo.py | 2 +- examples/pylab_examples/axhspan_demo.py | 2 +- examples/pylab_examples/axis_equal_demo.py | 2 +- examples/pylab_examples/figure_title.py | 2 +- examples/pylab_examples/fill_betweenx_demo.py | 2 +- examples/pylab_examples/plotfile_demo.py | 2 +- examples/pylab_examples/simple_plot.py | 2 +- examples/pylab_examples/specgram_demo.py | 6 +++--- examples/pylab_examples/symlog_demo.py | 2 +- examples/pylab_examples/xcorr_demo.py | 4 ++-- 12 files changed, 15 insertions(+), 17 deletions(-) diff --git a/examples/images_contours_and_fields/contourf_demo.py b/examples/images_contours_and_fields/contourf_demo.py index 4a89bf7755e4..e719a2655d35 100644 --- a/examples/images_contours_and_fields/contourf_demo.py +++ b/examples/images_contours_and_fields/contourf_demo.py @@ -3,7 +3,7 @@ Contourf Demo ============= -Example use of the `contourf` function to create filled contour plots. +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 05bcab765732..ef1fc109c341 100644 --- a/examples/images_contours_and_fields/contourf_hatching.py +++ b/examples/images_contours_and_fields/contourf_hatching.py @@ -3,7 +3,7 @@ Contourf Hatching ================= -Demo of filled contour plots with of hatched patterns. +Demo filled contour plots with of hatched patterns. """ import matplotlib.pyplot as plt import numpy as np @@ -30,8 +30,6 @@ ) plt.colorbar() -############################################################################### - # --------------------------------------------- # | Plot #2 | # --------------------------------------------- diff --git a/examples/pylab_examples/axes_demo.py b/examples/pylab_examples/axes_demo.py index f200b7f4e1c1..36b23d2c7b3f 100644 --- a/examples/pylab_examples/axes_demo.py +++ b/examples/pylab_examples/axes_demo.py @@ -3,7 +3,7 @@ Axes Demo ========= -Example use of `plt.axes` to create inset axes within the main plot axes. +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 02ddb7e48adc..8e9eac28ce69 100644 --- a/examples/pylab_examples/axhspan_demo.py +++ b/examples/pylab_examples/axhspan_demo.py @@ -3,7 +3,7 @@ Axhspan Demo ============ -The example shows how to create lines or rectangles that span the axes in either the horizontal or vertical direction. +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 ec77b0817230..568b89966cd8 100644 --- a/examples/pylab_examples/axis_equal_demo.py +++ b/examples/pylab_examples/axis_equal_demo.py @@ -3,7 +3,7 @@ Axis Equal Demo =============== -This example how to set and adjust plots with equal axis ratios. +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 575681cea06b..c4c2408b92b7 100644 --- a/examples/pylab_examples/figure_title.py +++ b/examples/pylab_examples/figure_title.py @@ -3,7 +3,7 @@ Figure Title ============ -Example use of `title` and `suptitle` to create subplot titles and a centered figure title, respectively. +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 0958e260ac50..660cdc155675 100644 --- a/examples/pylab_examples/fill_betweenx_demo.py +++ b/examples/pylab_examples/fill_betweenx_demo.py @@ -3,7 +3,7 @@ Fill Betweenx Demo ================== -This example shows how to use `fill_betweenx` to color between two horizontal curves. +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/plotfile_demo.py b/examples/pylab_examples/plotfile_demo.py index 3252835ed5c4..b927b4870add 100644 --- a/examples/pylab_examples/plotfile_demo.py +++ b/examples/pylab_examples/plotfile_demo.py @@ -3,7 +3,7 @@ Plotfile Demo ============= -Example use of `plotfile` to plot data directly from a file. +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/simple_plot.py b/examples/pylab_examples/simple_plot.py index 8ea7bce5f5f1..6a375ebbe359 100644 --- a/examples/pylab_examples/simple_plot.py +++ b/examples/pylab_examples/simple_plot.py @@ -3,7 +3,7 @@ Simple Plot =========== -Simple example of a 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 b252c551b93b..4c0a4509893a 100644 --- a/examples/pylab_examples/specgram_demo.py +++ b/examples/pylab_examples/specgram_demo.py @@ -1,7 +1,7 @@ """ -============= -Specgram Demo -============= +================ +Spectrogram Demo +================ Demo of a spectrogram plot. """ diff --git a/examples/pylab_examples/symlog_demo.py b/examples/pylab_examples/symlog_demo.py index d2d07744332b..c655e634744d 100644 --- a/examples/pylab_examples/symlog_demo.py +++ b/examples/pylab_examples/symlog_demo.py @@ -3,7 +3,7 @@ Symlog Demo =========== -Example use of symlog (symmetrical log) axis scaling. +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_demo.py index 5f48c74a2aea..21ec82b44666 100644 --- a/examples/pylab_examples/xcorr_demo.py +++ b/examples/pylab_examples/xcorr_demo.py @@ -1,9 +1,9 @@ """ ========== -Xcorr Demo +Cross-correlation Demo ========== -Example use of cross-correlation (`xcorr`) and auto-correlation (`acorr`) plots. +Example use of cross-correlation (``xcorr``) and auto-correlation (``acorr``) plots. """ import matplotlib.pyplot as plt import numpy as np From 923175d26a277389776009846e57e7fce54a8ad4 Mon Sep 17 00:00:00 2001 From: tonyyli Date: Sun, 16 Jul 2017 11:15:57 -0500 Subject: [PATCH 3/5] Equal length title lines --- examples/pylab_examples/xcorr_demo.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/pylab_examples/xcorr_demo.py b/examples/pylab_examples/xcorr_demo.py index 21ec82b44666..44752761747c 100644 --- a/examples/pylab_examples/xcorr_demo.py +++ b/examples/pylab_examples/xcorr_demo.py @@ -1,7 +1,7 @@ """ -========== +====================== Cross-correlation Demo -========== +====================== Example use of cross-correlation (``xcorr``) and auto-correlation (``acorr``) plots. """ From c808e3c4dcd10172d5061d583bcaaac28fe59dea Mon Sep 17 00:00:00 2001 From: tonyyli Date: Sun, 16 Jul 2017 11:24:02 -0500 Subject: [PATCH 4/5] Rename 'cross-correlation demo' to more accurate 'cross-/auto-correlation demo --- .../pylab_examples/{xcorr_demo.py => xcorr_acorr_demo.py} | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) rename examples/pylab_examples/{xcorr_demo.py => xcorr_acorr_demo.py} (86%) diff --git a/examples/pylab_examples/xcorr_demo.py b/examples/pylab_examples/xcorr_acorr_demo.py similarity index 86% rename from examples/pylab_examples/xcorr_demo.py rename to examples/pylab_examples/xcorr_acorr_demo.py index 44752761747c..58dd93ac9c9b 100644 --- a/examples/pylab_examples/xcorr_demo.py +++ b/examples/pylab_examples/xcorr_acorr_demo.py @@ -1,7 +1,7 @@ """ -====================== -Cross-correlation Demo -====================== +============================ +Cross-/Auto-correlation Demo +============================ Example use of cross-correlation (``xcorr``) and auto-correlation (``acorr``) plots. """ From 010808692c449806b7a9c01ceb9729fb74f37189 Mon Sep 17 00:00:00 2001 From: tonyyli Date: Sun, 16 Jul 2017 12:32:53 -0500 Subject: [PATCH 5/5] Edits to address PR coments --- examples/images_contours_and_fields/contourf_hatching.py | 2 +- examples/pylab_examples/spine_placement_demo.py | 2 +- examples/pylab_examples/xcorr_acorr_demo.py | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/images_contours_and_fields/contourf_hatching.py b/examples/images_contours_and_fields/contourf_hatching.py index ef1fc109c341..9d43210085db 100644 --- a/examples/images_contours_and_fields/contourf_hatching.py +++ b/examples/images_contours_and_fields/contourf_hatching.py @@ -3,7 +3,7 @@ Contourf Hatching ================= -Demo filled contour plots with of hatched patterns. +Demo filled contour plots with hatched patterns. """ 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 cb24c76aa604..d67a60f867bd 100644 --- a/examples/pylab_examples/spine_placement_demo.py +++ b/examples/pylab_examples/spine_placement_demo.py @@ -3,7 +3,7 @@ Spine Placement Demo ==================== -This example demos how to adjust the location and appearance of axis spines. +Adjusting the location and appearance of axis spines. """ import numpy as np import matplotlib.pyplot as plt diff --git a/examples/pylab_examples/xcorr_acorr_demo.py b/examples/pylab_examples/xcorr_acorr_demo.py index 58dd93ac9c9b..d388e38495e4 100644 --- a/examples/pylab_examples/xcorr_acorr_demo.py +++ b/examples/pylab_examples/xcorr_acorr_demo.py @@ -1,7 +1,7 @@ """ -============================ -Cross-/Auto-correlation Demo -============================ +================================ +Cross- and Auto-Correlation Demo +================================ Example use of cross-correlation (``xcorr``) and auto-correlation (``acorr``) plots. """ 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