summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortonyyli <tony.y.li@gmail.com>2017-07-15 16:24:25 -0500
committertonyyli <tony.y.li@gmail.com>2017-07-16 11:17:54 -0500
commit31168cb0d6d1aa84edd2a0d484011003284fbc34 (patch)
treedb3cb02adab01ef20cbb9d04b4c153d86cf64323
parent9dd0db61a7706844603ca7653856a13022f65541 (diff)
Add one-line descriptions to 19 examples currently missing them
-rw-r--r--examples/animation/image_slices_viewer.py1
-rw-r--r--examples/images_contours_and_fields/contourf_demo.py1
-rw-r--r--examples/images_contours_and_fields/contourf_hatching.py2
-rw-r--r--examples/pylab_examples/agg_buffer_to_array.py1
-rw-r--r--examples/pylab_examples/axes_demo.py1
-rw-r--r--examples/pylab_examples/axhspan_demo.py1
-rw-r--r--examples/pylab_examples/axis_equal_demo.py1
-rw-r--r--examples/pylab_examples/figure_title.py1
-rw-r--r--examples/pylab_examples/fill_betweenx_demo.py1
-rw-r--r--examples/pylab_examples/log_demo.py1
-rw-r--r--examples/pylab_examples/plotfile_demo.py1
-rw-r--r--examples/pylab_examples/polar_legend.py1
-rw-r--r--examples/pylab_examples/simple_plot.py1
-rw-r--r--examples/pylab_examples/specgram_demo.py1
-rw-r--r--examples/pylab_examples/spine_placement_demo.py1
-rw-r--r--examples/pylab_examples/stem_plot.py1
-rw-r--r--examples/pylab_examples/step_demo.py1
-rw-r--r--examples/pylab_examples/symlog_demo.py1
-rw-r--r--examples/pylab_examples/xcorr_demo.py1
19 files changed, 20 insertions, 0 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..4a89bf775 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 e28a64a88..05bcab765 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 @@ 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..f200b7f4e 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..02ddb7e48 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 4b5d928bc..ec77b0817 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 cd8d6023f..575681cea 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 7b827004a..0958e260a 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 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..3252835ed 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..8ea7bce5f 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 0a2f04ab9..b252c551b 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 3dc6b1f28..cb24c76aa 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 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..d2d077443 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 ab182fb74..5f48c74a2 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
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback