8000 DOC: Standardize example titles · matplotlib/matplotlib@55a993e · GitHub
[go: up one dir, main page]
Skip to content

Commit 55a993e

Browse files
timhoffmtimhoffm
committed
DOC: Standardize example titles
Following recommendatinos from #28527, this improves example titles. Take this as an incremental improvement. I've changed what I saw at a glance when going through the examples once. Certainly, one could do further improvements, but that can be done in follow-ups.
1 parent 199c31f commit 55a993e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+74
-73
lines changed

‎galleries/examples/animation/pause_resume.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
=================================
3-
Pausing and Resuming an Animation
3+
Pausing and resuming an animation
44
=================================
55
66
This example showcases:

‎galleries/examples/animation/unchained.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
========================
3-
MATPLOTLIB **UNCHAINED**
4-
========================
2+
====================
3+
Matplotlib unchained
4+
====================
55
66
Comparative path demonstration of frequency from a fake signal of a pulsar
77
(mostly known because of the cover for Joy Division's Unknown Pleasures).

‎galleries/examples/axes_grid1/scatter_hist_locatable_axes.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
==================================
3-
Scatter Histogram (Locatable Axes)
4-
==================================
2+
===========================================
3+
Scatter with histogram using locatable Axes
4+
===========================================
55
66
Show the marginal distributions of a scatter plot as histograms at the sides of
77
the plot.

‎galleries/examples/axisartist/simple_axis_pad.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
===============
3-
Simple Axis Pad
3+
Simple axis pad
44
===============
55
66
"""

‎galleries/examples/event_handling/close_event.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
===========
3-
Close Event
3+
Close event
44
===========
55
66
Example to show connecting events that occur when the figure closes.

‎galleries/examples/event_handling/looking_glass.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
=============
3-
Looking Glass
3+
Looking glass
44
=============
55
66
Example using mouse events to simulate a looking glass for inspecting data.

‎galleries/examples/event_handling/poly_editor.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
===========
3-
Poly Editor
4-
===========
2+
==============
3+
Polygon editor
4+
==============
55
66
This is an example to show how to build cross-GUI applications using
77
Matplotlib event handling to interact with objects on the canvas.

‎galleries/examples/event_handling/zoom_window.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
===========
3-
Zoom Window
4-
===========
2+
========================
3+
Zoom modifies other Axes
4+
========================
55
66
This example shows how to connect events in one window, for example, a mouse
77
press, to another figure window.

‎galleries/examples/images_contours_and_fields/barb_demo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
==========
3-
Wind Barbs
3+
Wind barbs
44
==========
55
66
Demonstration of wind barb plots.

‎galleries/examples/images_contours_and_fields/colormap_interactive_adjustment.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
========================================
3-
Interactive Adjustment of Colormap Range
3+
Interactive adjustment of colormap range
44
========================================
55
66
Demonstration of how a colorbar can be used to interactively adjust the

‎galleries/examples/images_contours_and_fields/contour_corner_mask.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
===================
3-
Contour Corner Mask
3+
Contour corner mask
44
===================
55
66
Illustrate the difference between ``corner_mask=False`` and

‎galleries/examples/images_contours_and_fields/contour_image.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
=============
3-
Contour Image
3+
Contour image
44
=============
55
66
Test combinations of contouring, filled contouring, and image plotting.

‎galleries/examples/images_contours_and_fields/contourf_hatching.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
=================
3-
Contourf Hatching
3+
Contourf hatching
44
=================
55
66
Demo filled contour plots with hatched patterns.

‎galleries/examples/images_contours_and_fields/image_masked.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
============
3-
Image Masked
4-
============
2+
========================
3+
Image with masked values
4+
========================
55
66
imshow with masked array input and out-of-range colors.
77

‎galleries/examples/images_contours_and_fields/layer_images.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
============
3-
Layer Images
4-
============
2+
================================
3+
Layer images with alpha blending
4+
================================
55
66
Layer images above one another using alpha blending
77
"""

‎galleries/examples/lines_bars_and_markers/bar_label_demo.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
==============
3-
Bar Label Demo
4-
==============
2+
=====================
3+
Bar chart with labels
4+
=====================
55
66
This example shows how to use the `~.Axes.bar_label` helper function
77
to create bar chart labels.

‎galleries/examples/lines_bars_and_markers/fill_between_alpha.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
"""
2-
Fill Between and Alpha
3-
======================
2+
==============================
3+
Fill Between with transparency
4+
==============================
45
56
The `~matplotlib.axes.Axes.fill_between` function generates a shaded
67
region between a min and max boundary that is useful for illustrating ranges.

‎galleries/examples/lines_bars_and_markers/scatter_masked.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
==============
3-
Scatter Masked
4-
==============
2+
====================
3+
Scatter with masking
4+
====================
55
66
Mask some data points and add a line demarking
77
masked regions.

‎galleries/examples/lines_bars_and_markers/simple_plot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
===========
3-
Simple Plot
3+
Simple plot
44
===========
55
66
Create a simple plot.

‎galleries/examples/lines_bars_and_markers/stem_plot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
=========
3-
Stem Plot
3+
Stem plot
44
=========
55
66
`~.pyplot.stem` plots vertical lines from a baseline to the y-coordinate and

‎galleries/examples/misc/image_thumbnail_sgskip.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
===============
3-
Image Thumbnail
3+
Image thumbnail
44
===============
55
66
You can use Matplotlib to generate thumbnails from existing images.

‎galleries/examples/misc/print_stdout_sgskip.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
============
3-
Print Stdout
3+
Print stdout
44
============
55
66
print png to standard out

‎galleries/examples/misc/svg_filter_line.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
===============
3-
SVG Filter Line
4-
===============
2+
==========================
3+
Apply SVG filter to a line
4+
==========================
55
66
Demonstrate SVG filtering effects which might be used with Matplotlib.
77

‎galleries/examples/scales/aspect_loglog.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
=============
3-
Loglog Aspect
3+
Loglog aspect
44
=============
55
66
"""

‎galleries/examples/shapes_and_collections/quad_bezier.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
============
3-
Bezier Curve
3+
Bezier curve
44
============
55
66
This example showcases the `~.patches.PathPatch` object to create a Bezier

‎galleries/examples/subplots_axes_and_figures/align_labels_demo.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
==========================
3-
Aligning Labels and Titles
4-
==========================
2+
=======================
3+
Align labels and titles
4+
=======================
55
66
Aligning xlabel, ylabel, and title using `.Figure.align_xlabels`,
77
`.Figure.align_ylabels`, and `.Figure.align_titles`.

‎galleries/examples/subplots_axes_and_figures/axes_props.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
==========
3-
Axes Props
4-
==========
2+
===============
3+
Axes properties
4+
===============
55
66
You can control the axis tick and grid properties
77
"""

‎galleries/examples/subplots_axes_and_figures/axes_zoom_effect.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
================
3-
Axes Zoom Effect
3+
Axes zoom effect
44
================
55
66
"""

‎galleries/examples/subplots_axes_and_figures/axis_labels_demo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
===================
3-
Axis Label Position
3+
Axis label position
44
===================
55
66
Choose axis label position when calling `~.Axes.set_xlabel` and

‎galleries/examples/subplots_axes_and_figures/broken_axis.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
===========
3-
Broken Axis
3+
Broken axis
44
===========
55
66
Broken axis example, where the y-axis will have a portion cut out.

‎galleries/examples/text_labels_and_annotations/annotate_transform.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
==================
3-
Annotate Transform
3+
Annotate transform
44
==================
55
66
This example shows how to use different coordinate systems for annotations.

‎galleries/examples/text_labels_and_annotations/annotation_demo.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
================
3-
Annotating Plots
4-
================
2+
==============
3+
Annotate plots
4+
==============
55
6< 10000 /code>6
The following examples show ways to annotate plots in Matplotlib.
77
This includes highlighting specific points of interest and using various

‎galleries/examples/text_labels_and_annotations/annotation_polar.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
================
3-
Annotation Polar
4-
================
2+
====================
3+
Annotate polar plots
4+
====================
55
66
This example shows how to create an annotation on a polar graph.
77

‎galleries/examples/text_labels_and_annotations/custom_legends.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
========================
3-
Composing Custom Legends
3+
Composing custom legends
44
========================
55
66
Composing custom legends piece-by-piece.

‎galleries/examples/text_labels_and_annotations/demo_text_rotation_mode.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
r"""
22
==================
3-
Text Rotation Mode
3+
Text rotation mode
44
==================
55
66
This example illustrates the effect of ``rotation_mode`` on the positioning

‎galleries/examples/text_labels_and_annotations/mathtext_examples.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
=================
3-
Mathtext Examples
4-
=================
2+
========================
3+
Mathematical expressions
4+
========================
55
66
Selected features of Matplotlib's math rendering engine.
77
"""

‎galleries/examples/text_labels_and_annotations/text_commands.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
=============
3-
Text Commands
3+
Text commands
44
=============
55
66
Plotting text of many different kinds.

‎galleries/examples/text_labels_and_annotations/text_rotation_relative_to_line.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
2-
==============================
3-
Text Rotation Relative To Line
4-
==============================
2+
==========================================
3+
Text rotation to angle in data coordinates
4+
==========================================
55
66
Text objects in matplotlib are normally rotated with respect to the
77
screen coordinate system (i.e., 45 degrees rotation plots text along a

‎galleries/examples/text_labels_and_annotations/usetex_baseline_test.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
====================
3-
Usetex Baseline Test
3+
Usetex baseline test
44
====================
55
66
Comparison of text baselines computed for mathtext and usetex.

‎galleries/examples/ticks/date_precision_and_epochs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
=========================
3-
Date Precision and Epochs
3+
Date precision and epochs
44
=========================
55
66
Matplotlib can handle `.datetime` objects and `numpy.datetime64` objects using

‎galleries/examples/units/units_sample.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
======================
3-
Inches and Centimeters
3+
Inches and centimeters
44
================ 949B ======
55
66
The example illustrates the ability to override default x and y units (ax1) to

‎galleries/examples/widgets/range_slider.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
======================================
3-
Thresholding an Image with RangeSlider
3+
Thresholding an image with RangeSlider
44
======================================
55
66
Using the RangeSlider widget to control the thresholding of an image.

0 commit comments

Comments
 (0)
0