Skip to content

DOC: Standardize example titles #28544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion galleries/examples/animation/pause_resume.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
=================================
Pausing and Resuming an Animation
Pausing and resuming an animation
=================================

This example showcases:
Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/animation/unchained.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
========================
MATPLOTLIB **UNCHAINED**
========================
====================
Matplotlib unchained
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fun and not at all descriptive :/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no better name and don't know if anybody feels strongly about this particular title. So I've just removed the special formatting.

====================

Comparative path demonstration of frequency from a fake signal of a pulsar
(mostly known because of the cover for Joy Division's Unknown Pleasures).
Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/axes_grid1/scatter_hist_locatable_axes.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
==================================
Scatter Histogram (Locatable Axes)
==================================
====================================================
Align histogram to scatter plot using locatable Axes
====================================================

Show the marginal distributions of a scatter plot as histograms at the sides of
the plot.
Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/axisartist/simple_axis_pad.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
===============
Simple Axis Pad
Simple axis pad
===============

"""
Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/event_handling/close_event.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
===========
Close Event
Close event
===========

Example to show connecting events that occur when the figure closes.
Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/event_handling/looking_glass.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
=============
Looking Glass
Looking glass
=============

Example using mouse events to simulate a looking glass for inspecting data.
Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/event_handling/poly_editor.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
===========
Poly Editor
===========
==============
Polygon editor
==============

This is an example to show how to build cross-GUI applications using
Matplotlib event handling to interact with objects on the canvas.
Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/event_handling/zoom_window.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
===========
Zoom Window
===========
========================
Zoom modifies other Axes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would folks recognize `brushing-linking w/ zoom" or too jargony?

If jargony, then this brush-link should be added in tags at some point and maybe in the discription

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"brushing-linking" does not tell me anything :/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds like it's a good candidate for a tag then, rather than a title. https://infovis-wiki.net/wiki/Linking_and_Brushing

========================

This example shows how to connect events in one window, for example, a mouse
press, to another figure window.
Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/images_contours_and_fields/barb_demo.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
==========
Wind Barbs
Wind barbs
==========

Demonstration of wind barb plots.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
========================================
Interactive Adjustment of Colormap Range
Interactive adjustment of colormap range
========================================

Demonstration of how a colorbar can be used to interactively adjust the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
===================
Contour Corner Mask
Contour corner mask
===================

Illustrate the difference between ``corner_mask=False`` and
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
=============
Contour Image
Contour image
=============

Test combinations of contouring, filled contouring, and image plotting.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
=================
Contourf Hatching
Contourf hatching
=================

Demo filled contour plots with hatched patterns.
Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/images_contours_and_fields/image_masked.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
============
Image Masked
============
========================
Image with masked values
========================

imshow with masked array input and out-of-range colors.

Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/images_contours_and_fields/layer_images.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
============
Layer Images
============
================================
Layer images with alpha blending
================================

Layer images above one another using alpha blending
"""
Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/lines_bars_and_markers/bar_label_demo.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
==============
Bar Label Demo
==============
=====================
Bar chart with labels
=====================

This example shows how to use the `~.Axes.bar_label` helper function
to create bar chart labels.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""
Fill Between and Alpha
======================
==============================
Fill Between with transparency
==============================

The `~matplotlib.axes.Axes.fill_between` function generates a shaded
region between a min and max boundary that is useful for illustrating ranges.
Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/lines_bars_and_markers/scatter_masked.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
==============
Scatter Masked
==============
==========================
Scatter with masked values
==========================

Mask some data points and add a line demarking
masked regions.
Expand Down
8 changes: 4 additions & 4 deletions galleries/examples/lines_bars_and_markers/simple_plot.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""
===========
Simple Plot
===========
=========
Line plot
=========

Create a simple plot.
Create a basic line plot.
"""

import matplotlib.pyplot as plt
Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/lines_bars_and_markers/stem_plot.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
=========
Stem Plot
Stem plot
=========

`~.pyplot.stem` plots vertical lines from a baseline to the y-coordinate and
Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/misc/image_thumbnail_sgskip.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
===============
Image Thumbnail
Image thumbnail
===============

You can use Matplotlib to generate thumbnails from existing images.
Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/misc/print_stdout_sgskip.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
============
Print Stdout
============
=====================
Print image to stdout
=====================

print png to standard out

Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/misc/svg_filter_line.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
===============
SVG Filter Line
===============
==========================
Apply SVG filter to a line
==========================

Demonstrate SVG filtering effects which might be used with Matplotlib.

Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/scales/aspect_loglog.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
=============
Loglog Aspect
Loglog aspect
=============

"""
Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/shapes_and_collections/quad_bezier.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
============
Bezier Curve
Bezier curve
============

This example showcases the `~.patches.PathPatch` object to create a Bezier
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
==========================
Aligning Labels and Titles
==========================
=======================
Align labels and titles
=======================

Aligning xlabel, ylabel, and title using `.Figure.align_xlabels`,
`.Figure.align_ylabels`, and `.Figure.align_titles`.
Expand Down
6 changes: 3 additions & 3 deletions galleries/examples/subplots_axes_and_figures/axes_props.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
==========
Axes Props
==========
===============
Axes properties
===============

You can control the axis tick and grid properties
"""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
================
Axes Zoom Effect
Axes zoom effect
================

"""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
===================
Axis Label Position
Axis label position
===================

Choose axis label position when calling `~.Axes.set_xlabel` and
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
===========
Broken Axis
Broken axis
===========

Broken axis example, where the y-axis will have a portion cut out.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
==================
Annotate Transform
Annotate transform
==================

This example shows how to use different coordinate systems for annotations.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
================
Annotating Plots
================
==============
Annotate plots
==============

The following examples show ways to annotate plots in Matplotlib.
This includes highlighting specific points of interest and using various
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
================
Annotation Polar
================
====================
Annotate polar plots
====================

This example shows how to create an annotation on a polar graph.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
========================
Composing Custom Legends
========================
======================
Compose custom legends
======================

Composing custom legends piece-by-piece.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
r"""
==================
Text Rotation Mode
Text rotation mode
==================

This example illustrates the effect of ``rotation_mode`` on the positioning
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
=================
Mathtext Examples
=================
========================
Mathematical expressions
========================

Selected features of Matplotlib's math rendering engine.
"""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
=============
Text Commands
=============
===============
Text properties
===============

Plotting text of many different kinds.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
==============================
Text Rotation Relative To Line
==============================
=======================================
Text rotation angle in data coordinates
=======================================

Text objects in matplotlib are normally rotated with respect to the
screen coordinate system (i.e., 45 degrees rotation plots text along a
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
====================
Usetex Baseline Test
Usetex text baseline
====================

Comparison of text baselines computed for mathtext and usetex.
Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/ticks/date_precision_and_epochs.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
=========================
Date Precision and Epochs
Date precision and epochs
=========================

Matplotlib can handle `.datetime` objects and `numpy.datetime64` objects using
Expand Down
2 changes: 1 addition & 1 deletion galleries/examples/units/units_sample.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
======================
Inches and Centimeters
Inches and centimeters
======================

The example illustrates the ability to override default x and y units (ax1) to
Expand Down
Loading